CalendarNotes
List calendar notes
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.
get/shop/calendar-notes
Query parameters
site_idstring required
Filter results by the site they belong to
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
Response
A paginated list of CalendarNote objects for the site.
Example response
{
"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",
"updated_by_id": "33333333-3333-3333-3333-333333333333",
"created_at": "2026-05-23T09:30:00Z",
"updated_at": "2026-05-23T09:30:00Z"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.