API reference · Free/Busy
Free/Busy
Bulk availability lookups and the multi-constraint slot-finder.
★
Aspirational surface. This resource is part of the developer-platform roadmap. The field shapes follow the same conventions as live resources and are stable for prototype integrations.
Endpoints
POST
/v1/freebusy/query
Busy windows across N participants
POST
/v1/freebusy/find_slots
Candidate free slots matching constraints
Query busy windows
HTTP
POST /v1/freebusy/query
Returns time-windows occupied by events across one or more participants.
| Field | Type | Description |
|---|---|---|
| participants | array | Mix of usr_… IDs, calendar IDs, or external emails (external:guest@example.com). |
| from | datetime | Window start. |
| to | datetime | Window end. |
| include_tentative | boolean | Default false. |
Response:
JSON
{
"object": "freebusy",
"participants": {
"usr_1abc2def3ghi": {
"busy": [
{ "start": "2026-05-22T09:00:00-07:00", "end": "2026-05-22T10:00:00-07:00" }
]
}
},
"request_id": "req_…"
}Find candidate slots
HTTP
POST /v1/freebusy/find_slots
Multi-constraint optimizer. Returns candidate free slots that satisfy duration, working hours, and inter-meeting buffers.
| Field | Type | Description |
|---|---|---|
| participants | array | required |
| duration_minutes | integer | required |
| earliest_start | datetime | required |
| latest_end | datetime | required |
| working_hours | object? | start, end, days (array of weekday names). |
| buffer_minutes_between_meetings | integer? | Default 0. |
| preferred_time_of_day | string? | morning, afternoon, evening. |
| limit | integer? | Default 5, max 25. |
Each returned slot includes a score (0.0–1.0) ranking it against the constraints.