GET
/
v2
/
calendars
/
busy-times
Get busy times
curl --request GET \
  --url https://api.cal.com/v2/calendars/busy-times \
  --header 'Authorization: <authorization>'
{
  "status": "success",
  "data": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "source": "<string>"
    }
  ]
}

Headers

​
Authorization
string
required

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

Query Parameters

​
loggedInUsersTz
string
required

The timezone of the logged in user represented as a string

​
dateFrom
string

The starting date for the busy times query

​
dateTo
string

The ending date for the busy times query

​
credentialId
number
required

The ID of the user's calendar credential used to access the calendar. Retrieve this from your connected calendar credentials via the /v2/credentials endpoint.

​
externalId
string
required

The external calendar identifier from the calendar provider (e.g., email address for Google Calendar). This is returned when listing connected calendars.

Response

200 - application/json

The response is of type object.