Sign in
Calendars

Get busy times

Get busy times from a calendar. Example request URL is https://api.cal.com/v2/calendars/busy-times?timeZone=Europe%2FMadrid&dateFrom=2024-12-18&dateTo=2024-12-18&calendarsToLoad[0][credentialId]=135&calendarsToLoad[0][externalId]=skrauciz%40gmail.com. Note: loggedInUsersTz is deprecated, use timeZone instead.

get/v2/calendars/busy-times

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: Authorization

Query parameters

loggedInUsersTzstring
Example:America/New_York

Deprecated: Use timeZone instead. The timezone of the user represented as a string

timeZonestring
Example:America/New_York

The timezone for the busy times query represented as a string

dateFromstring
Example:2023-10-01

The starting date for the busy times query

dateTostring
Example:2023-10-31

The ending date for the busy times query

credentialIdnumber required
externalIdstring required

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

Response

status'success' | 'error' required

Example response

{
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.