Get Free Slots - HoopAI Help Center

GET

calendars

{calendarId}

free-slots

Get Free Slots

curl --request GET \
  --url https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

const options = {
  method: 'GET',
  headers: {Version: '<version>', Authorization: 'Bearer <token>'}
};

fetch('https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots"

headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "2024-10-28": {
    "slots": [
      "2024-10-28T10:00:00-05:00",
      "2024-10-28T11:00:00-05:00"
    ]
  },
  "2024-10-29": {
    "slots": [
      "2024-10-29T10:00:00-05:00",
      "2024-10-29T14:30:00-05:00"
    ]
  }
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorizations

Authorization

string

header

required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version

enum<string>

required

API Version

Available options:

2021-04-15

Path Parameters

calendarId

string

required

Calendar Id

Example:

"ocQHyuzHvysMo5N5VsXc"

Query Parameters

startDate

number

required

Start Date (⚠️ Important: Date range cannot be more than 31 days)

Example:

1548898600000

endDate

number

required

End Date (⚠️ Important: Date range cannot be more than 31 days)

Example:

1601490599999

timezone

string

The timezone in which the free slots are returned

Example:

"America/Chihuahua"

userId

string

The user for whom the free slots are returned

Example:

"082goXVW3lIExEQPOnd3"

userIds

string[]

The users for whom the free slots are returned

Response

Availability map keyed by date (YYYY-MM-DD)

{key}

object

Show child attributes

Last modified on March 8, 2026

Get Calendar

Update Calendar

Get Free Slots

curl --request GET \
  --url https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

const options = {
  method: 'GET',
  headers: {Version: '<version>', Authorization: 'Bearer <token>'}
};

fetch('https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots"

headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "2024-10-28": {
    "slots": [
      "2024-10-28T10:00:00-05:00",
      "2024-10-28T11:00:00-05:00"
    ]
  },
  "2024-10-29": {
    "slots": [
      "2024-10-29T10:00:00-05:00",
      "2024-10-29T14:30:00-05:00"
    ]
  }
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}