curl --request GET \
--url https://services.leadconnectorhq.com/calendars/schedules/search \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"schedules": [
{
"id": "IkqiJlXJ7o9h61tCHHod",
"name": "Business Hours Schedule",
"locationId": "IkqiJlXJ7o9h61tCHHod",
"rules": [
{
"type": "wday",
"intervals": [
{
"from": "09:00",
"to": "17:00"
}
],
"date": "2023-04-15",
"day": "monday"
}
],
"timezone": "America/New_York",
"dateAdded": "2023-01-15T10:30:00.000Z",
"dateUpdated": "2023-01-20T14:45:00.000Z",
"userId": "IkqiJlXJ7o9h61tCHHod",
"deleted": false,
"calendarIds": [
"<string>"
]
}
]
}Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination.
curl --request GET \
--url https://services.leadconnectorhq.com/calendars/schedules/search \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"schedules": [
{
"id": "IkqiJlXJ7o9h61tCHHod",
"name": "Business Hours Schedule",
"locationId": "IkqiJlXJ7o9h61tCHHod",
"rules": [
{
"type": "wday",
"intervals": [
{
"from": "09:00",
"to": "17:00"
}
],
"date": "2023-04-15",
"day": "monday"
}
],
"timezone": "America/New_York",
"dateAdded": "2023-01-15T10:30:00.000Z",
"dateUpdated": "2023-01-20T14:45:00.000Z",
"userId": "IkqiJlXJ7o9h61tCHHod",
"deleted": false,
"calendarIds": [
"<string>"
]
}
]
}Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
API Version
2021-04-15 Location ID to filter schedules by
"IkqiJlXJ7o9h61tCHHod"
User ID to filter schedules by specific user
"IkqiJlXJ7o9h61tCHHod"
Calendar ID for filtering schedules by specific calendar
"WvVX9LpvlBO6K506xLbp"
Number of items to skip for pagination
x >= 00
Maximum number of items to return (max 500)
1 <= x <= 50050
Schedules retrieved successfully
Array of schedules
Show child attributes
Was this page helpful?