List user availability schedule

GET 
/calendars/schedules/search

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

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID to filter schedules by

userId stringrequired

User ID to filter schedules by specific user

calendarId string

Calendar ID for filtering schedules by specific calendar

skip number

Number of items to skip for pagination

Possible values: >= 0

Default value:0

limit number

Maximum number of items to return (max 500)

Possible values: >= 1 and <= 500

Default value:50

application/json

Schedules retrieved successfully

application/json

Schema

Schema

schedulesobject[]required

Array of schedules

Example (auto)

{
  "schedules": [
    {
      "id": "IkqiJlXJ7o9h61tCHHod",
      "name": "Business Hours Schedule",
      "locationId": "ocQHyuzHvysMo5N5VsXc"
    }
  ]
}