Retrieve user availability schedules based on various filters including account, calendar, and user. Supports pagination.
Retrieve user availability schedules based on various filters including account, calendar, and user. Supports pagination.
http
GET https://services.leadconnectorhq.com/calendars/schedules/search
Authorization
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Query parameters
Name
Type
Required
Example
Description
locationId
string
Yes
IkqiJlXJ7o9h61tCHHod
Account ID to filter schedules by
userId
string
Yes
IkqiJlXJ7o9h61tCHHod
User ID to filter schedules by specific user
calendarId
string
No
WvVX9LpvlBO6K506xLbp
Calendar ID for filtering schedules by specific calendar
skip
number
No
0
Number of items to skip for pagination
limit
number
No
50
Maximum number of items to return (max 500)
Responses
200 - Schedules retrieved successfully
schedules (object[], required): Array of schedules
id (string, required): Unique identifier for the schedule Example: IkqiJlXJ7o9h61tCHHod
name (string, required): Human-readable name for the schedule Example: Business Hours Schedule
locationId (string, required): Account ID where this schedule applies Example: IkqiJlXJ7o9h61tCHHod
rules (object[], required): Schedule rules defining when the schedule is active
type (string, required): Type of schedule rule - weekday (recurring) or date (specific date) Possible values: 'wday', 'date' Example: wday
intervals (object[], required): Time intervals for the rule (e.g., 9 AM to 5 PM)
from (string, required): Start time in HH:MM format (24-hour format) Example: 09:00
to (string, required): End time in HH:MM format (24-hour format) Example: 17:00
date (string): Specific date in YYYY-MM-DD format (only for date-type rules) Example: 2023-04-15
day (string): Day of week (only for weekday-type rules) Possible values: 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday' Example: monday
timezone (string, required): Timezone for the schedule (IANA timezone identifier) Example: America/New_York
dateAdded (string, required): ISO date string when the schedule was created Example: 2023-01-15T10:30:00.000Z
dateUpdated (string, required): ISO date string when the schedule was last updated Example: 2023-01-20T14:45:00.000Z
userId (string, required): User ID associated with the schedule Example: IkqiJlXJ7o9h61tCHHod
calendarIds (string[]): Calendar IDs associated with the schedule
deleted (boolean, required): Whether the schedule has been deleted Example: False