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.

timezone
string

Read the slots in this zone instead of the calendar's own.

lookaheadDays
integer

How far ahead to look, overriding maxDaysOut.

Required range: 1 <= x <= 365
minNoticeMinutes
integer

How soon the first slot may be, overriding the calendar.

Required range: x >= 0

Response

Open start times, keyed by day.

success
boolean
required
data
object
required
{key}
any