List user availability schedule

Query parameters

string

default:"IkqiJlXJ7o9h61tCHHod"

required

Account ID to filter schedules by

string

default:"IkqiJlXJ7o9h61tCHHod"

required

User ID to filter schedules by specific user

string

default:"WvVX9LpvlBO6K506xLbp"

Calendar ID for filtering schedules by specific calendar

number

default:"0"

Number of items to skip for pagination

number

default:"50"

Maximum number of items to return (max 500)

Respuestas

200 - Schedules retrieved successfully

object[]

required

Array of schedules

Show cada item

string

default:"IkqiJlXJ7o9h61tCHHod"

required

Unique identifier for the schedule

string

default:"Business Hours Schedule"

required

Human-readable name for the schedule

string

default:"IkqiJlXJ7o9h61tCHHod"

required

Account ID where this schedule applies

object[]

required

Schedule rules defining when the schedule is active

Show cada item

string

default:"wday"

required

Type of schedule rule - weekday (recurring) or date (specific date) Posibles valores: ‘wday’, ‘date’

object[]

required

Time intervals for the rule (e.g., 9 AM to 5 PM)

Show cada item

string

default:"09:00"

required

Start time in HH:MM format (24-hour format)

string

default:"17:00"

required

End time in HH:MM format (24-hour format)

string

default:"2023-04-15"

Specific date in YYYY-MM-DD format (only for date-type rules)

string

default:"monday"

Day of week (only for weekday-type rules) Posibles valores: ‘sunday’, ‘monday’, ‘tuesday’, ‘wednesday’, ‘thursday’, ‘friday’, ‘saturday’

string

default:"America/New_York"

required

Timezone for the schedule (IANA timezone identifier)

string

default:"2023-01-15T10:30:00.000Z"

required

ISO date string when the schedule was created

string

default:"2023-01-20T14:45:00.000Z"

required

ISO date string when the schedule was last updated

string

default:"IkqiJlXJ7o9h61tCHHod"

required

User ID associated with the schedule

string[]

Calendar IDs associated with the schedule

boolean

default:"False"

required

Whether the schedule has been deleted

{
  "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

{}

401 - User not authenticated

{}

Ejemplo

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

const response = await fetch('https://services.leadconnectorhq.com/calendars/schedules/search', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/calendars/schedules/search',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/calendars/schedules/search');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

List user availability schedule

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo