Calendar & Scheduling

Calendar Events

A CalendarEvent represents an offering occurrence.

get/shop/calendar-events-v2

Returns occupancy metrics for the operator calendar on a given date. The response counts the guests covered by all confirmed/waitlisted offerings (appointments, area bookings, and sessions) that fall within the date — bucketed by hour, by selected view, and as a single daily total.

Occupancy is gated by the occupancy_overview feature flag. If the flag is off for the site, the underlying data resolves to null. Filter results by view_type (and optionally zone_id) to constrain the calculation to a single resource lane.

Query parameters

datedateoptional
The date to fetch events for
eventsstringoptional
A comma-separated list of event keys and event types to return. The format is {event_type}..{event_key}, for example: appointment..1234_5678,session..5678_9012
view_typestringoptional
The view type (resource) to return events for. If specified, an event object will be returned for each resource of this type in the event.
Possible values:areapractitionerroom
zone_idstringoptional
The zone ID to filter events for.
site_idstringoptional
Filter results by the site they belong to

Responses

200
Calendar occupancy successfully retrieved.
400
The request failed.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/calendar-occupancy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/calendar-occupancy', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/calendar-occupancy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/calendar-occupancy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/calendar-occupancy", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Calendar occupancy successfully retrieved.

{
  "data": {
    "occupancy_for_view": 42,
    "occupancy_per_day": 87,
    "occupancy_per_hour": [
      {
        "guests": 6,
        "time": "09:00"
      }
    ]
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

get/shop/calendar-resources

List calendar resources for a date

listCalendarResources

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.

Query parameters

datedateoptional
The date to fetch events for
zone_idstringoptional
The zone ID to filter events for.
site_idstringoptional
Filter results by the site they belong to

Responses

200
Calendar resources successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl "https://api.playground.try.be/shop/calendar-resources" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/calendar-resources', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/calendar-resources",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/calendar-resources', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/calendar-resources", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Calendar resources successfully retrieved.

{
  "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"
      }
    ],
    "practitioners": [
      {
        "id": "6622aabb11cc22dd33ee44ff"
      }
    ],
    "rooms": [
      {
        "id": "6622cc55ddeeff0011223344"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

Calendar Events

List calendar events

Query parameters

Responses

Get calendar occupancy

Query parameters

Responses

List calendar resources for a date

Query parameters

Responses