Calendar & Scheduling

Calendar Notes

A CalendarNote is a free-form, date-scoped annotation that surfaces on the operator calendar for a site (e.g. public holidays, marketing events, known understaffed shifts). Notes do not affect availability or block bookings.

get/shop/calendar-notes

List calendar notes

listCalendarNotes

Returns a paginated list of CalendarNote objects for the given site. Notes can be filtered by an exact date or a date range to populate the calendar viewport.

Requires the RESERVATIONS_VIEW permission on the site.

Query parameters

site_idstringrequired
Filter results by the site they belong to
datedate-timeoptional
A date string to retrieve results for
dateFromdate-timeoptional
A date string to retrieve results from
dateTodate-timeoptional
A date string to retrieve results to
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
A paginated list of CalendarNote objects for the site.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/calendar-notes?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/calendar-notes?site_id=site_abc123', {
  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-notes?site_id=site_abc123",
    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-notes?site_id=site_abc123', [
    '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-notes?site_id=site_abc123", 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)
}

A paginated list of `CalendarNote` objects for the site.

{
  "data": [
    {
      "id": "5f1234567890abcdef123456",
      "site_id": "11111111-1111-1111-1111-111111111111",
      "body": "Public holiday — front desk closes at 16:00.",
      "date": "2026-05-25",
      "created_by_id": "33333333-3333-3333-3333-333333333333",
      "created_by": {},
      "updated_by_id": "33333333-3333-3333-3333-333333333333",
      "updated_by": {},
      "deleted_by": {},
      "created_at": "2026-05-23T09:30:00Z",
      "updated_at": "2026-05-23T09:30:00Z"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

post/shop/calendar-notes

Create a calendar note

createCalendarNote

Creates a new CalendarNote against a site for a given date. Requires the RESERVATIONS_MANAGE permission on the target site.

Request body

bodystringrequired
The note text. Plain text only — line breaks are preserved but no markdown is rendered. There is no hard length limit, but keep it short so it reads well in the calendar.
datedaterequired
The calendar date the note applies to, in YYYY-MM-DD format. The date is interpreted in the site's local timezone.
site_iduuidoptional
ID of the site to attach the note to. The caller's API key must have access to the site and the RESERVATIONS_MANAGE permission on it. Defaults to the site from the request context when omitted.

Responses

201
A single CalendarNote.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/calendar-notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Public holiday — front desk closes at 16:00.",
  "date": "2026-05-25",
  "site_id": "11111111-1111-1111-1111-111111111111"
}'

const response = await fetch('https://api.playground.try.be/shop/calendar-notes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "body": "Public holiday — front desk closes at 16:00.",
    "date": "2026-05-25",
    "site_id": "11111111-1111-1111-1111-111111111111"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/calendar-notes",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "body": "Public holiday — front desk closes at 16:00.",
        "date": "2026-05-25",
        "site_id": "11111111-1111-1111-1111-111111111111"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/calendar-notes', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'body' => 'Public holiday — front desk closes at 16:00.',
            'date' => '2026-05-25',
            'site_id' => '11111111-1111-1111-1111-111111111111'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"body": "Public holiday — front desk closes at 16:00.",
		"date": "2026-05-25",
		"site_id": "11111111-1111-1111-1111-111111111111",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/calendar-notes", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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)
}

A single `CalendarNote`.

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "site_id": "11111111-1111-1111-1111-111111111111",
    "body": "Public holiday — front desk closes at 16:00.",
    "date": "2026-05-25",
    "created_by_id": "33333333-3333-3333-3333-333333333333",
    "created_by": {},
    "updated_by_id": "33333333-3333-3333-3333-333333333333",
    "updated_by": {},
    "deleted_by": {},
    "created_at": "2026-05-23T09:30:00Z",
    "updated_at": "2026-05-23T09:30:00Z"
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/shop/calendar-notes/{calendarNoteId}

Retrieve a calendar note

getCalendarNote

Returns a single CalendarNote by ID. Requires the RESERVATIONS_VIEW permission on the note's site.

Path parameters

calendarNoteIdobject-idrequired
The unique identifier of the CalendarNote.

Responses

200
A single CalendarNote.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/calendar-notes/abc123', {
  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-notes/abc123",
    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-notes/abc123', [
    '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-notes/abc123", 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)
}

A single `CalendarNote`.

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "site_id": "11111111-1111-1111-1111-111111111111",
    "body": "Public holiday — front desk closes at 16:00.",
    "date": "2026-05-25",
    "created_by_id": "33333333-3333-3333-3333-333333333333",
    "created_by": {},
    "updated_by_id": "33333333-3333-3333-3333-333333333333",
    "updated_by": {},
    "deleted_by": {},
    "created_at": "2026-05-23T09:30:00Z",
    "updated_at": "2026-05-23T09:30:00Z"
  }
}

{
  "message": "Unauthenticated"
}

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

{
  "message": "The requested resource could not be found"
}

put/shop/calendar-notes/{calendarNoteId}

Update a calendar note

updateCalendarNote

Partially updates a CalendarNote. Every field is optional; only fields you send are written. Requires the RESERVATIONS_MANAGE permission on the note's current site (and the target site too, if site_id is changed).

Path parameters

calendarNoteIdobject-idrequired
The unique identifier of the CalendarNote.

Request body

bodystringoptional
Replacement note text, shown to staff on the calendar view. Plain text only — HTML tags are stripped.
datedateoptional
Move the note to a different calendar date, in YYYY-MM-DD format.
site_iduuidoptional
Move the note to a different site. The caller's API key must have access to both the old and new site.

Responses

200
A single CalendarNote.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/calendar-notes/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Public holiday — front desk closes at 17:00.",
  "date": "2026-05-26",
  "site_id": "11111111-1111-1111-1111-111111111111"
}'

const response = await fetch('https://api.playground.try.be/shop/calendar-notes/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "body": "Public holiday — front desk closes at 17:00.",
    "date": "2026-05-26",
    "site_id": "11111111-1111-1111-1111-111111111111"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/calendar-notes/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "body": "Public holiday — front desk closes at 17:00.",
        "date": "2026-05-26",
        "site_id": "11111111-1111-1111-1111-111111111111"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/calendar-notes/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'body' => 'Public holiday — front desk closes at 17:00.',
            'date' => '2026-05-26',
            'site_id' => '11111111-1111-1111-1111-111111111111'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"body": "Public holiday — front desk closes at 17:00.",
		"date": "2026-05-26",
		"site_id": "11111111-1111-1111-1111-111111111111",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/calendar-notes/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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)
}

A single `CalendarNote`.

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "site_id": "11111111-1111-1111-1111-111111111111",
    "body": "Public holiday — front desk closes at 16:00.",
    "date": "2026-05-25",
    "created_by_id": "33333333-3333-3333-3333-333333333333",
    "created_by": {},
    "updated_by_id": "33333333-3333-3333-3333-333333333333",
    "updated_by": {},
    "deleted_by": {},
    "created_at": "2026-05-23T09:30:00Z",
    "updated_at": "2026-05-23T09:30:00Z"
  }
}

{
  "message": "Unauthenticated"
}

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

{
  "message": "The requested resource could not be found"
}

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

delete/shop/calendar-notes/{calendarNoteId}

Delete a calendar note

deleteCalendarNote

Removes a CalendarNote. Requires the RESERVATIONS_MANAGE permission on the note's site.

Path parameters

calendarNoteIdobject-idrequired
The unique identifier of the CalendarNote.

Responses

204
Calendar note deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/calendar-notes/abc123', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/calendar-notes/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/calendar-notes/abc123', [
    '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("DELETE", "https://api.playground.try.be/shop/calendar-notes/abc123", 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 note deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

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

{
  "message": "The requested resource could not be found"
}