Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

calendarId
string
required

The calendar id.

Minimum string length: 1

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.

Response

The calendar.

success
boolean
required
data
object
required

A bookable calendar: when it is open, how long an appointment lasts, and how far ahead it will go.

{key}
any