Skip to main content
POST
calendar.calendar.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by calendar.calendar.create or calendar.calendars.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

name
string
required

Calendar name.

description
string

Calendar description.

location
string

Calendar location.

timezone
string

IANA time zone, such as UTC.

isPrimary
boolean

Whether this is the primary calendar.

metadata
object
textColor
string
backgroundColor
string
readOnly
boolean

Whether this calendar is read only.