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

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Query parameters

NameTypeRequiredExampleDescription
locationIdstringYesIkqiJlXJ7o9h61tCHHodAccount ID to filter schedules by
userIdstringYesIkqiJlXJ7o9h61tCHHodUser ID to filter schedules by specific user
calendarIdstringNoWvVX9LpvlBO6K506xLbpCalendar ID for filtering schedules by specific calendar
skipnumberNo0Number of items to skip for pagination
limitnumberNo50Maximum 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

json
{
  "schedules": [
    {
      "id": "IkqiJlXJ7o9h61tCHHod",
      "name": "Business Hours Schedule",
      "locationId": "IkqiJlXJ7o9h61tCHHod",
      "rules": [
        {}
      ],
      "timezone": "America/New_York",
      "dateAdded": "2023-01-15T10:30:00.000Z",
      "dateUpdated": "2023-01-20T14:45:00.000Z",
      "userId": "IkqiJlXJ7o9h61tCHHod",
      "calendarIds": [
        "string"
      ],
      "deleted": false
    }
  ]
}
400 - Invalid request parameters
json
{}
401 - User not authenticated
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/calendars/schedules/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?