CalendarEvents
List calendar events
This endpoint lists calendar events.
get/shop/calendar-events-v2
Query parameters
datestring date
The date to fetch events for
eventsstring
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
include_customersstring boolean
Whether to include a CalendarEvents associated customers.
include_paymentsstring boolean
Whether to include a CalendarEvents associated payments.
include_session_bookingsstring boolean
Whether to include a CalendarEvents associated bookings.
view_type'area' | 'practitioner' | 'room'
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.
zone_idstring
The zone ID to filter events for.
site_idstring
Filter results by the site they belong to
Response
Calendar events successfully retrieved.
Example response
{
"data": [
{
"id": "6220d459e7c1c2f0ff31c3f3",
"areas": [
{
"name": "Hot Tub 1"
}
],
"blocked_time_details": {
"color": "#f55656",
"label": "Lunch",
"notes": "Can be rearranged if required.",
"type": "break",
"created_at": "2019-06-15T12:00:00+01:00",
"created_by": {
"avatar": {
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"original_url": "https://example.com/media/super-cool-photo.jpg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
},
"first_name": "Jane",
"full_name": "Jane Smith",
"last_name": "Smith"
}
},
"bookings": [
{
"id": "5e9823c217483703da555555",
"guests": [
{
"name": "Jane Smith",
"checked_in_at": "2025-10-01T12:00:00+00:00"
}
],
"order": {
"id": "5e9823c217483703da777777",
"customer": {
"email": "janedoe@example.com",
"first_name": "Jane",
"full_name": "Jane Doe",
"last_name": "Doe",
"phone": "+447900000000"
},
"email": "janedoe@example.com",
"external_visit_ref": "RES1234",
"first_name": "Jane",
"has_posting_room": true,
"intake_form_required": true,
"is_locked": true,
"labels": [
{
"color": "#FF0000",
"name": "VIP"
}
],
"last_name": "Doe",
"notes": [
{
"id": "5ed2b95f72823c4f98419f19",
"content": "Requested a double treatment room.",
"order_id": "5ed2b95f72823c4f98419f20",
"created_at": "2019-01-15T12:00:00+01:00",
"created_by": {
"id": "5ed2b95f72823c4f98419f20",
"name": "Jane Smith"
},
"created_by_id": "5ed2b95f72823c4f98419f20"
}
],
"order_ref": "TRY00",
"payment_totals": {
"chargeable": 500,
"missing": 1000,
"paid": 750,
"pending": 250,
"provided": 1500,
"unpaid": 1000
},
"phone": "+447727123456",
"special_requests": "I would like the Blue Room please",
"status": "complete"
},
"status": "confirmed"
}
],
"duration": 60,
"end_time": "2022-03-04T13:15:00+00:00",
"guests": [
{
"name": "Jane Smith",
"checked_in_at": "2025-10-01T12:00:00+00:00"
}
],
"key": "6220d459e7c1c2f0ff31c3f3_5dcb47800000000000000010",
"locked": true,
"num_overlaps": 1,
"offering_id": "5e9823c217483703da222222",
"offering_name": "Alpha Massage",
"order": {
"id": "5e9823c217483703da777777",
"customer": {
"email": "janedoe@example.com",
"first_name": "Jane",
"full_name": "Jane Doe",
"last_name": "Doe",
"phone": "+447900000000"
},
"email": "janedoe@example.com",
"external_visit_ref": "RES1234",
"first_name": "Jane",
"has_posting_room": true,
"intake_form_required": true,
"is_locked": true,
"labels": [
{
"color": "#FF0000",
"name": "VIP"
}
],
"last_name": "Doe",
"notes": [
{
"id": "5ed2b95f72823c4f98419f19",
"content": "Requested a double treatment room.",
"order_id": "5ed2b95f72823c4f98419f20",
"created_at": "2019-01-15T12:00:00+01:00",
"created_by": {
"id": "5ed2b95f72823c4f98419f20",
"name": "Jane Smith"
},
"created_by_id": "5ed2b95f72823c4f98419f20"
}
],
"order_ref": "TRY00",
"payment_totals": {
"chargeable": 500,
"missing": 1000,
"paid": 750,
"pending": 250,
"provided": 1500,
"unpaid": 1000
},
"phone": "+447727123456",
"special_requests": "I would like the Blue Room please",
"status": "complete"
},
"practitioners": [
{
"id": "5dcb47800000000000000000",
"name": "Jane Doe"
}
],
"product_code": "ULO346",
"reserved_until": "2022-03-04T12:00:00+00:00",
"resource_id": "5dcb47800000000000000010",
"resource_type": "practitioner",
"rooms": [
{
"id": "5dcb47800000000000000000"
}
],
"session_details": {
"capacity": 20,
"num_booked": 10,
"waitlist_enabled": true
},
"start_time": "2022-03-04T12:00:00+00:00",
"status": "confirmed",
"warnings": [
{
"code": "no_practitioner_assigned"
}
]
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.