--- title: "List Appointments" method: GET path: "/shop/appointments" tags: ["Appointments"] --- # List Appointments `GET /shop/appointments` Returns a paginated list of `Appointment`s, optionally filtered by the date range the appointments fall in, the date range that the underlying `Order`s were submitted in, and by `Practitioner`, `Room`, or `Zone`. Appointments are ordered by `start_time` ascending. This endpoint powers the calendar list views, day-sheet exports (via the CSV variant returned when `Accept: text/csv`), and any third-party reporting integration that needs the same data the Trybe dashboard renders. ## Query parameters - `page` integer - `per_page` integer - `site_id` string, required - `date_from` string, date - `date_to` string, date - `order_submitted_at_from` string, date - `order_submitted_at_to` string, date - `practitioner_id` string[] - `room_id` string[] - `zone_id` string[] ## Response `200` Successfully retrieved `Appointment`s. - object — Paginated envelope mixin. `allOf` this into any list response that wraps its `data` array with `meta` + `links`; the concrete schema keeps its own title so the SDK surface is unchanged, while the `meta` / `links` shape is sourced from a single definition. - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present. - `first` string, required — The url of the first page for the paginated results set - `next` string, nullable, required — The url of the next page for the paginated results set - `prev` string, nullable, required — The url of the previous page for the paginated results set - `last` string, required — The url of the last page for the paginated results set - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped). - `from` integer, required — The item number from which this results set starts from - `to` integer, required — The item number from which this results set ends at - `total` integer, required — The total number of results - `current_page` integer, required — The current page number - `last_page` integer, required — The page number of the last result set - `per_page` integer, required — The number of results per page - `path` string, required — The path of this api request - `data` SchemasAppointment[], required - `id` string, object-id, required — The ID of the appointment. - `appointment_type_id` string, object-id, required — The ID of the appointment type. - `appointment_type_name` string, required — The name of the appointment type. - `currency` string — The ISO-4217 currency code. - `customer_id` string, object-id, required — The ID of the customer this appointment is for. - `duration` integer, required — The duration of the appointment in minutes. - `email` string, required — The email address of the customer. - `end_buffer` integer, required — The number of minutes blocked out at the end of the appointment for cleaning or changeover. - `end_time` string, date-time, required — The end time this appointment is for. - `first_name` string, required — The first name of the customer. - `full_name` string — The full name of the customer. - `guests` Guest[], required - `id` string, object-id, required — Stable identifier for the guest slot on an order. Used to attach intake-form answers, check the guest in or out, and link the slot to a `Customer` once one is resolved. - `checked_in_at` string, date-time, nullable, required — ISO-8601 timestamp at which the guest checked in for their visit. `null` until check-in happens. - `checked_out_at` string, date-time, nullable, required — ISO-8601 timestamp at which the guest checked out / finished their visit. `null` while the visit is still in progress. - `customer_id` string, uuid, nullable, required — The `Customer` the guest slot has been linked to, if any. `null` for walk-ins or anonymous guests that haven't been matched to a customer record yet. - `email` string, email, nullable — Email address captured for this guest, used to send the pre-visit intake form and post-visit follow-ups. `null` when no email has been supplied for the slot. - `first_name` string, required — The first name of the guest. - `intake_form_submission_id` string, object-id — Identifier of the most recent intake-form submission for this guest, if one exists. Use this to fetch the submitted answers from the guest-intake API. - `intake_form_complete` boolean, required — Whether the intake form for the guest is complete. - `is_lead_booker` boolean, required — Whether the guest is the lead booker. - `last_name` string, required — The last name of the guest. - `name` string, required — Full display name for the guest — typically `first_name` plus `last_name`, but kept as a separate field so the platform can render it consistently across receipts, intake forms and check-in screens. - `has_notes` boolean, required — Whether the appointment belongs to an order that has notes. - `has_outstanding_balance` boolean, required — Whether the appointment belongs to an order that has an outstanding balance. - `has_special_requests` boolean, required — Whether the appointment belongs to an order that has special requests. - `is_group_booking` boolean, required — Whether the appointment belongs to an order that has multiple guests. - `is_hotel_room_booking` boolean — Whether the appointment belongs to an order that is associated with a hotel room. - `is_locked` boolean — Whether the appointment is locked and should not be moved. - `is_part_of_package` boolean, required — Whether the appointment was sold as part of a package - `last_name` string, required — The last name of the customer. - `net_total` integer, required — The net total of the appointment. - `order_id` string, object-id, required — The ID of the order associated with this appointment. - `order_is_locked` boolean, required — Whether the order is locked - `order_item_id` string, object-id, required — The ID of the order item associated with this appointment. - `order_labels` SchemasLabel[], required - `id` string, object-id, required — The ID of the label. - `color` string, required — The color of the label. - `name` string, required — The name of the label. - `order_id` string, object-id, required - `order_locked_at` string, date-time — The date the order was locked at - `order_ref` string, required — The order reference associated with this appointment. - `organisation_id` string, uuid, required — The ID of the organisation the appointment belongs to. - `package_product_code` string — The product code for the package. - `phone` string, required — The customer's phone number. - `practitioner_ids` string[], required — The IDs of the practitioners this appointment assigned to. - `practitioners` PractitionerSummary[], required - `id` string, object-id, required — The ID of the practitioner. - `name` string, required — The full name of the practitioner. - `product_code` string, nullable, required — A custom product code for the product. - `room` RoomSummary, required — The summary of a `Room` object - `id` string, object-id, required — The ID of the room. - `capacity` integer, required - `name` string, required — The name of the room. - `room_id` string, object-id, required — The ID of the room this appointment assigned to. - `site_id` string, uuid, required — The ID of the site the appointment belongs to. - `stage` 'arrived' | 'checked_out' | 'in_treatment' | 'not_arrived', required — The current stage of the order the appointment belongs to. - `start_time` string, date-time, required — The start time this appointment is for. - `status` 'confirmed' | 'in_progress' | 'new', required — The status of the appointment. - `submitted_at` string, date-time, required — The date and time the appointment was submitted. - `total_cost` integer, required — The total cost of the appointment. - `created_at` string, date-time, required — When then resource was created. - `updated_at` string, date-time, required — When then resource was last updated. - `totals` Totals, required - `net_total` integer, required - `total_items` integer, required ## Other responses - `401` — The user is unauthenticated - `403` — The authenticated user does not have permission. --- [API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)