Data and Freshness
What the answers contain, when data changes, and how to keep a copy up to date.
Answers
- A single resource comes as
{ "data": { } }, a list asdata,paginationandmeta. - Field names are camelCase. Every documented field is always present: a field without a value is
null, and an empty list is[]. - Ids are opaque strings. Don't rely on their format.
- Dates are
YYYY-MM-DDand times are UTC with milliseconds, like2026-10-29T08:00:00.000Z. - A reference to another resource (a booking's
user, for example) is an object with that resource's id and a few fields such as a name. Its values are current, not as they were when the booking was made. - Every answer carries a
Request-Idheader andCache-Control: no-store.
Who is included
- Bookings, presence days and presence counts include only users with an active seat. Guests are not included.
- Archived users keep their history: their bookings and presence stay, and
GET /users/{userId}still returns them withstatus: archived. - Visits include every visit, in every status, cancelled ones too. A visit's
hostisnullwhen the host is not a user of your organization. ItsvisitorandvisitorTypeshow the visitor's current details, not those at the time of the visit.
When data changes
There is no change feed in the beta. Past data can change: bookings are edited or deleted, presence can be recomputed, and old data is removed. To keep a copy up to date, re-read a recent window and replace what you stored for it.
- A cancelled or deleted booking no longer appears, so a re-read drops it.
- A visit deleted by your organization's Visit data retention setting no longer appears. That setting counts from when the visit was created, not from its date. Moving a calendar meeting to another calendar cancels its visit and creates a new one with a new id.
- Presence data older than your organization's retention period is removed. The removal runs daily, so for about a day such data can still appear.
HEAD and OPTIONS
HEAD on an endpoint runs it without returning a body and counts against the
rate limits. OPTIONS answers 404 route_not_found.
Last updated on