Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId
string
required

The sub-account this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call.

from
string
required

Start of the window, ISO.

to
string
required

End of the window, ISO.

calendarId
string

Narrow to one calendar.

includeCancelled
enum<string>

Include cancelled appointments.

Available options:
true

Response

What is in the window.

success
boolean
required
data
object[]
required
{key}
any