---
title: "List appointment enquiries"
method: GET
path: "/shop/reports/sessions"
tags: ["Reports"]
---

# List appointment enquiries

`GET /shop/reports/sessions`

Use this endpoint to retrieve a list of `Session`s.

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `id` string[]
- `date` string, date
- `date_from` string, date
- `date_to` string, date
- `start_time_from` string, date-time
- `start_time_to` string, date-time
- `session_type_id` string, mongo-id
- `recurrence_group_id` string, mongo-id
- `room_id` string, mongo-id
- `practitioner_id` string, mongo-id
- `zone_id` string, mongo-id
- `include_cancelled` boolean
- `cancelled` boolean
- `include_bookings` boolean

## Response `200`

The list of `Session` resources was successfully retrieved.

- ListSessionsResponse
  - `data` SchemasSession2[], required
    - `id` string, mongo-id, required — The ID of the session.
    - `session_type_id` string, mongo-id, required — The ID of the session type.
    - `session_type_name` string, required — The name of the session type.
    - `practitioner_id` string, mongo-id, required — The ID of the practitioner assigned to this session.
    - `practitioner` PractitionerSummary, required — The summary of a `Practitioner` object
      - `id` string, object-id, required — The ID of the practitioner.
      - `name` string, required — The full name of the practitioner.
    - `room_id` string, mongo-id, required — The ID of the room where the session is taking place.
    - `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.
    - `start_time` string, date-time, required — The date and time that the session starts.
    - `end_time` string, date-time, required — The date and time that the session ends.
    - `duration` integer, required — The duration of the session in minutes.
    - `capacity` integer, required — The total allowed capacity of the session.
    - `num_booked` integer, required — The total number of guests that have booked this session.
    - `remaining_capacity` integer, required — The remaining capacity of the session.
    - `max_baskets` integer, required — The maximum number of orders that will be allowed to have bookings for this session.
    - `waitlist_enabled` boolean, required — Whether the waitlist is enabled for this session.
    - `num_waitlisted` integer, required — The total number of guests on the waitlist for this session.
    - `price` integer, required — The price of this session.
    - `currency` string, The currency used for this session., required
    - `created_at` string, date-time, required — The date and time this session was created.
    - `updated_at` string, date-time, required — The date and time this session was updated.
    - `deleted_at` string, date-time — The date and time this session was cancelled.
    - `site_id` string, uuid, required — The ID of the site where this session is taking place.
  - `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
  - `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
  - `totals` SessionListTotals, required
    - `capacity` integer, required — The total allowed capacity of all sessions.
    - `num_booked` integer, required — The total number of guests that have booked across all sessions.
    - `remaining_capacity` integer, required — The total remaining capacity of all sessions.

## Other responses

- `401` — The user is unauthenticated

---

[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)