Sign in
Sessions

List Sessions

This endpoint lists all Sessions.

get/shop/sessions

Query parameters

cancelledboolean

Whether to exclusively return cancelled Sessions.

idstring

A comma separated list of Session ids to search for.

include_bookingsboolean

Whether to include associated Bookings.

include_cancelledboolean

Whether to include cancelled Sessions.

practitioner_idstring

A comma separated list of Practitioner ids.

recurrence_group_idstring

A comma separated list of SessionRecurrenceGroup ids.

room_idstring

A comma separated list of Room ids.

session_type_idstring

A comma separated list of SessionType ids.

zone_idstring

A comma separated list of Zone ids.

datestring date
Example:2000-01-01

A date string to retrieve results for

dateFromstring date
Example:2000-01-01

A date string to retrieve results from

dateTostring date
Example:2000-01-01

A date string to retrieve results to

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

site_idstring

Filter results by the site they belong to

start_time_fromstring date-time
Example:2000-01-01T17:00:00+01:00

Filter results by when they start.

start_time_tostring date-time
Example:2000-01-01T20:00:00+01:00

Filter results by when they end.

Response

The Sessions were successfully retrieved.

Example response

{
  "data": [
    {
      "id": "5dcb47800000000000000010",
      "bookings": [
        {
          "id": "5dcb47800000000000000000",
          "checked_in_at": "2022-03-02T09:00:00+00:00",
          "checked_out_at": "2022-03-02T10:00:00+00:00",
          "customer_id": "5dcb47800000000000000020",
          "email": "janedoe@example.com",
          "first_name": "Jane",
          "guests": [
            {
              "id": "5dcb47800000000000000000",
              "checked_in_at": "2025-10-01T12:00:00+00:00",
              "checked_out_at": "2025-10-01T16:30:00+00:00",
              "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
              "email": "jane.doe@example.com",
              "first_name": "Jane",
              "intake_form_submission_id": "5dcb47800000000000000010",
              "last_name": "Doe",
              "name": "Jane Doe"
            }
          ],
          "intake_form_required": true,
          "last_name": "Doe",
          "order_id": "5dcb47800000000000000009",
          "order_item_id": "5dcb47800000000000000019",
          "order_ref": "TRY00",
          "organisation_id": "00000000-0000-0000-0000-000000000000",
          "phone": "+447727123456",
          "session_id": "5dcb47800000000000001111",
          "session_type_id": "5dcb47800000000000001234",
          "session_type_name": "Spa access",
          "site_id": "00000000-0000-0000-0000-111111111111",
          "status": "none"
        }
      ],
      "capacity": 10,
      "currency": "gbp",
      "duration": 60,
      "end_time": "2019-01-15T12:00:00+01:00",
      "max_baskets": 1,
      "num_checked_in": 12,
      "num_no_show": 2,
      "num_waitlisted": 2,
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "practitioner_id": "5dcb47800000000000000010",
      "price": 595,
      "remaining_capacity": 4,
      "room": {
        "id": "5dcb47800000000000000000"
      },
      "room_id": "5dcb47800000000000000010",
      "session_type_id": "5dcb47800000000000000010",
      "session_type_name": "Spa access",
      "site_id": "5dcb47800000000000000010",
      "start_time": "2019-01-15T11:00:00+01:00",
      "waitlist_enabled": true,
      "max_waitlist_size": 10,
      "created_at": "2019-01-15T12:00:00+01:00",
      "deleted_at": "2019-01-15T12:00:00+01:00",
      "updated_at": "2019-01-15T12:00:00+01:00"
    }
  ],
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.