Logo
Zoom Public API Documentation

Query freebusy information for a set of calendars

POST {{baseUrl}}/calendars/freeBusy

Returns free or busy information for a set of calendars.

Scopes: calendar:write,calendar:write:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status OK

{ "kind": "calendar#freeBusy", "timeMax": "<dateTime>", "timeMin": "<dateTime>", "calendars": [ { "id": "<string>", "errors": [ { "domain": "<string>", "reason": "<string>" }, { "domain": "<string>", "reason": "<string>" } ], "busy": [ { "start": "<string>", "end": "<string>" }, { "start": "<string>", "end": "<string>" } ] }, { "id": "<string>", "errors": [ { "domain": "<string>", "reason": "<string>" }, { "domain": "<string>", "reason": "<string>" } ], "busy": [ { "start": "<string>", "end": "<string>" }, { "start": "<string>", "end": "<string>" } ] } ], "groups": [ { "id": "<string>", "errors": { "domain": "<string>", "reason": "<string>" }, "calendars": [ "<string>", "<string>" ] }, { "id": "<string>", "errors": { "domain": "<string>", "reason": "<string>" }, "calendars": [ "<string>", "<string>" ] } ] }



Curl
curl -X POST 'https://api.zoom.us/v2/calendars/freeBusy' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"timeMax":"\u003cdateTime\u003e","timeMin":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e","calendarExpansionMax":"\u003cinteger\u003e","groupExpansionMax":"\u003cinteger\u003e","items":[{"id":"\u003cemail\u003e"},{"id":"\u003cemail\u003e"}]}'

ENDPOINTS