Listing events
Retrieve a paginated list of scheduled events withGET /scheduled-events. Use query parameters to filter and sort the results.
Available filters
Example: filter by date range and status
scope=all. This requires a token with the admin:full scope.
Getting event details
Retrieve full details for a single event withGET /scheduled-events/{uuid}. Event UUIDs follow the format zg-XXX (for example, zg-O69bac566950c6).
Example response
customQueryParams, utm, guests, and teamName each keep one JSON shape on every response from every scheduled-event endpoint. customQueryParams is always an object. If the booking captured no custom parameters, the object is empty ({}). utm is always an object with all five keys (utm_campaign, utm_source, utm_medium, utm_term, utm_content). If the booking did not carry a value for a key, that key holds null. guests is always an array. If the invitee added no guests, the array is empty ([]). teamName is always present. If the booking was made on a personal scheduling page, it holds null. It carries the same value the invitee.scheduled webhook sends for that booking, so you can recover the team after a missed delivery. Check for the empty value directly ({}, [], or a null key) instead of testing the type.Cancelling events
Cancel a scheduled event withPUT /scheduled-events/{uuid}/cancel. You can optionally include a cancellationReason (maximum 512 characters) that will be shared with participants.
200 response confirming the operation.
Cancelling individual invitees
For group events where you need to remove a single attendee without cancelling the entire event, usePUT /scheduled-invitees/{uuid}/cancel. The invitee UUID can be found in the event details response.
Marking no-shows
When an invitee doesn’t turn up, mark them as a no-show withPOST /scheduled-invitees/{uuid}/no-show. It has the same effect as marking them in the dashboard: workflows triggered by a no-show run, the CRM records the missed meeting, and webhooks subscribed to invitee.no_show receive the invitee. The response is the invitee, with noShow: true and the noShowAt timestamp.
- The booking must have started. Marking earlier, or marking an invitee whose seat is cancelled, rescheduled or unconfirmed, returns
422. - Both calls are safe to repeat: marking a marked invitee, or undoing an unmarked one, returns the invitee unchanged.
- Undoing a marking cancels no-show workflow steps that haven’t run yet. It sends no webhook, and it doesn’t restore workflow steps the marking cancelled.
Rescheduling events
Move a booking to a new date and time withPUT /scheduled-events/{uuid}/reschedule. Call GET /scheduled-events/{uuid}/reschedule-availability first: it lists the times the scheduling page offers for that booking, and the reschedule accepts exactly those. The booking gets a new event uuid and a new invitee uuid; the response names both.
To move a booking to a time the scheduling page does not offer, send overrideLevel. It works as it does when you create a booking, and the token’s user must be allowed to edit both the scheduling page and the booking.
No level moves a booking to a time in the past, into a busy room, or into a group event without enough free seats. A time that is still refused returns
400 with data.blockedReason naming what blocks it, such as calendar. A token whose user may not edit the scheduling page and the booking returns 403.
cURL
Handing over events
Transfer a Round Robin event to a different host withPUT /scheduled-events/{uuid}/handover. You can specify the new host explicitly or let the system auto-assign one based on the Round Robin rules.
Options
By default the new host must be free at the time of the booking. A handover ignores buffers and minimum notice because the booking already exists, and a named
newHostEmail is also exempt from booking limits. Send overrideLevel to hand over to a host who is not free. Each level opens everything the one before it opens:
For example, Marco Rossi has a calendar entry from 09:00 to 10:00 and a booking runs at 09:00. Level
3 hands it to him, and level 2 returns 400. Level 4 is available in the public API, the MCP server and the CLI only.
A host the level does not open returns 400. A token whose user may not edit the scheduling page returns 403.
A booking that moves in place emails the new host, with the booking details and who it came from, and tells the previous host it is no longer theirs. The invitee receives no email, and nothing is sent when the event type turns host emails off. A booking rescheduled through fallbackToReschedule sends the usual reschedule emails to the invitee and the hosts instead.