Sign in
CalendarEvents

List calendar resources for a date

Returns the resources displayed alongside the operator calendar for a given date — the lanes you book against. The response bundles:

  • The site's opening hours for the date, expressed as one or more open periods (a site can have split shifts).
  • All Zones configured at the site (used to filter the calendar by area of the venue).
  • Every BookableArea, Practitioner, and Room at the site, each enriched with the resource's scheduled availability for the requested date and (for practitioners) any custom availability overrides that apply.

Pass zone_id to restrict the resource lanes to a single zone; omitting it returns every resource at the site. The endpoint is typically called once per calendar render and refreshed when the operator changes date.

get/shop/calendar-resources

Query parameters

datestring date

The date to fetch events for

zone_idstring

The zone ID to filter events for.

site_idstring

Filter results by the site they belong to

Response

Calendar resources successfully retrieved.

Example response

{
  "data": {
    "opening_hours": [
      {
        "start_time": "2026-05-23T08:00:00+01:00",
        "end_time": "2026-05-23T20:00:00+01:00"
      }
    ],
    "zones": [
      {
        "id": "6622d459e7c1c2f0ff31c3f3",
        "name": "Spa"
      }
    ],
    "areas": [
      {
        "id": "6622e1f3ab50c4baa0f1d4a2",
        "slots": [
          {
            "start_time": "2026-05-23T09:00:00+01:00",
            "end_time": "2026-05-23T17:00:00+01:00"
          }
        ]
      }
    ],
    "practitioners": [
      {
        "id": "6622aabb11cc22dd33ee44ff",
        "slots": [
          {
            "start_time": "2026-05-23T09:00:00+01:00",
            "end_time": "2026-05-23T17:00:00+01:00",
            "room_segments": [
              {
                "id": "6622ff00112233445566aabb",
                "room_id": "6622cc55ddeeff0011223344",
                "start_time": "2026-05-23T09:00:00+01:00",
                "end_time": "2026-05-23T13:00:00+01:00",
                "offerings": [
                  {
                    "offering_name": "Twilight massage",
                    "offering_type": "appointment"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "rooms": [
      {
        "id": "6622cc55ddeeff0011223344",
        "slots": [
          {
            "start_time": "2026-05-23T09:00:00+01:00",
            "end_time": "2026-05-23T17:00:00+01:00"
          }
        ]
      }
    ]
  }
}

Changes