call_next_ticket
ChatGPTCall next ticket for the authenticated user's account
get_all_locations
ChatGPTRetrieves all locations for the authenticated user's account. DEFAULT FIELDS (always included): - id, name: Always returned for each location OPTIONAL RESOURCES (included only when you specify their fields): - ipads: Include by specifying ipadFields - tvs: Include by specifying tvFields - desks: Include by specifying deskFields - lines: Include by specifying lineFields - users: Include by specifying userFields - languages: Include by specifying languageFields VALID FIELD VALUES: - basicFields: address, countryCode, country, timezone, created, latitude, longitude, smsEnabled, isDemo - ipadFields: id, name, online, charging, batteryLevel - tvFields: id, name, theme, layout, online - deskFields: id, name, user (user returns nested object with id, email) - lineFields: id, name, color, disabled, archived - userFields: id, email, firstName, lastName - languageFields: code, name, nativeName, primary RETURN VALUE: JSON array of location objects with requested fields and nested resources. EXAMPLES: Example 1 - Minimal (just id and name): {} Example 2 - Locations with address info: { "basicFields": ["address", "country", "timezone"] } Example 3 - Locations with lines and users: { "lineFields": ["id", "name", "color"], "userFields": ["id", "email", "firstName"] } Example 4 - Full location details: { "basicFields": ["address", "timezone", "country", "smsEnabled"], "lineFields": ["id", "name", "color", "disabled"], "deskFields": ["id", "name", "user"], "userFields": ["id", "email", "firstName", "lastName"], "ipadFields": ["id", "name", "online"] }
get_appointments
ChatGPTGet scheduled appointments for a location within a date range. Returns appointment times, assigned staff, and optional customer/ticket details. CRITICAL TIMEZONE REQUIREMENT: ALL RETURNED TIMES (startTime, endTime) ARE IN UTC TIMEZONE. YOU MUST CONVERT TO THE LOCATION'S TIMEZONE BEFORE DISPLAYING TO USERS. The location's timezone is provided in the location data - use it for all time conversions. DEFAULT FIELDS (always included): - id: Ticket ID - appointment { startTime, endTime, assignee { id, firstName, lastName, email } } OPTIONAL RESOURCES (included only when you specify their fields): - line: Include by specifying lineFields - fields: Include by specifying fieldsFields (custom fields) - labels: Include by specifying labelsFields - language: Include by specifying languageFields Common use cases: 1. View today's appointments with customer details: - Set startDate/endDate to today's date range - Add basicFields: ["status", "firstName", "lastName", "phoneNumber"] 2. Check specific staff member's schedule: - Use assigneeIds: [456, 789] - Appointments assigned to these users only 3. Filter by appointment status: - statuses: ["SCHEDULED"] for upcoming appointments - statuses: ["SCHEDULING_NOSHOW", "SCHEDULING_CANCELLED", "SCHEDULING_CANCELLED_BY_VISITOR"] for no-shows and cancellations 4. Export with full context: - Add lineFields: ["id", "name", "color"] - Add labelsFields: ["value", "color"] - Add fieldsFields: ["id", "value", "options", "inputField"] FILTERS: - assigneeIds: Filter by staff member IDs - lineIds: Filter by service line IDs - statuses: SCHEDULED, CALLED, SERVED, SCHEDULING_CANCELLED, SCHEDULING_CANCELLED_BY_VISITOR, SCHEDULING_NOSHOW - limit: Max results (default 100, max 1000) VALID FIELD VALUES: - basicFields: status, firstName, lastName, phoneNumber, email - lineFields: id, name, color - fieldsFields: id, value, options, inputField - labelsFields: value, color - languageFields: code, name Date format: ISO 8601 with timezone, e.g., "2025-01-15T14:30:00.000Z"
get_current_user
ChatGPTRetrieves information about the currently authenticated user. DEFAULT FIELDS (always included): - id, email: Always returned - selectedLocation: Always returned with default fields [id, name, timezone] You can customize selectedLocation fields using selectedLocationFields parameter. OPTIONAL RESOURCES (included only when you specify their fields): - profilePicture: Include by specifying profilePictureFields - selectedDesk: Include by specifying selectedDeskFields - selectedLines: Include by specifying selectedLinesFields - roles: Include by specifying roleFields VALID FIELD VALUES: - basicFields: firstName, lastName, created, lastLoggedIn, lastInvited, deleted, deletedAt - selectedLocationFields: id, name, timezone, address, country (default: [id, name, timezone]) - selectedDeskFields: id, name - selectedLinesFields: id, name, color, disabled, archived - profilePictureFields: medium, large - roleFields: type, location (location returns nested object with id and name) RETURN VALUE: JSON object containing user data with requested fields and nested resources. EXAMPLES: Example 1 - Minimal (id, email, selectedLocation with defaults): {} Example 2 - Basic user info with custom location fields: { "basicFields": ["firstName", "lastName"], "selectedLocationFields": ["id", "name", "timezone", "address"] } Example 3 - User with profile picture: { "profilePictureFields": ["medium"] } Example 4 - Full profile with all resources: { "basicFields": ["firstName", "lastName", "created"], "selectedLocationFields": ["id", "name", "timezone", "address"], "selectedDeskFields": ["id", "name"], "selectedLinesFields": ["id", "name", "color"], "profilePictureFields": ["medium", "large"], "roleFields": ["type", "location"] }
get_location_by_id
ChatGPTRetrieves location by id for the authenticated user's account. DEFAULT FIELDS (always included): - id, name: Always returned OPTIONAL RESOURCES (included only when you specify their fields): - ipads: Include by specifying ipadFields - tvs: Include by specifying tvFields - desks: Include by specifying deskFields - lines: Include by specifying lineFields - users: Include by specifying userFields - languages: Include by specifying languageFields VALID FIELD VALUES: - basicFields: address, countryCode, country, timezone, created, latitude, longitude, smsEnabled, isDemo - ipadFields: id, name, online, charging, batteryLevel - tvFields: id, name, theme, layout, online - deskFields: id, name, user (user returns nested object with id, email) - lineFields: id, name, color, disabled, archived - userFields: id, email, firstName, lastName - languageFields: code, name, nativeName, primary RETURN VALUE: JSON object of location with requested fields and nested resources. EXAMPLES: Example 1 - Minimal (just id and name): { "id": 123 } Example 2 - Location with address info: { "id": 123, "basicFields": ["address", "country", "timezone"] } Example 3 - Location with lines and users: { "id": 123, "lineFields": ["id", "name", "color"], "userFields": ["id", "email", "firstName"] } Example 4 - Full location details: { "id": 123, "basicFields": ["address", "timezone", "country", "smsEnabled"], "lineFields": ["id", "name", "color", "disabled"], "deskFields": ["id", "name", "user"], "userFields": ["id", "email", "firstName", "lastName"] }