Skip to main content
AvailabilityVersion: v3

List user availability schedule

GET/calendars/schedules/search

Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Location ID to filter schedules by

Example:IkqiJlXJ7o9h61tCHHod
userIdstringrequired

User ID to filter schedules by specific user

Example:IkqiJlXJ7o9h61tCHHod
calendarIdstring

Calendar ID for filtering schedules by specific calendar

Example:WvVX9LpvlBO6K506xLbp
skipnumber

Number of items to skip for pagination

Possible values: >= 0

Default:0
Example:0
limitnumber

Maximum number of items to return (max 500)

Possible values: >= 1 and <= 500

Default:50
Example:50

Response

application/json

Schedules retrieved successfully

schedulesobject[]required

Array of schedules