Get Calendar preferences

GET

/api/v1/calendar/preferences

const url = 'https://example.com/api/v1/calendar/preferences';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/calendar/preferences \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User. It returns the saved Calendar display and drag settings. Route: /api/v1/calendar/preferences. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

Calendar preferences that follow the User to every Installation.

object

date_format

required

Numeric date pattern, or system for the Installation’s locale.

string

Allowed values: system dmy_slash_padded_short mdy_slash_short dmy_slash_short mdy_slash_long dmy_slash_padded_long dmy_dot dmy_dash ymd_slash ymd_dot iso

default_event_calendar_id

Stable ID of the User’s default Event calendar, or None when no Calendar is connected yet.

string | null

first_day_of_week

required

Week start, or system for the Installation’s locale.

string

Allowed values: system sunday monday saturday

hour_height

required

Week and Day zoom: the height of one hour in CSS pixels, 24 to 160.

integer format: int32

snap_to_items

required

Align dragged items with nearby item edges when the pointer is close.

boolean

snap_to_now

required

Align dragged items with the current-time line when the pointer is close.

boolean

time_format

required

Clock cycle, or system for the Installation’s locale.

string

Allowed values: system 24_hour 12_hour

time_step_minutes

required

Grid interval for pointer and keyboard movement: 5, 10, 15 or 30 minutes.

integer format: int32

>= 5 <= 30 multiple of 5

Allowed values: 5 10 15 30

Example

{
  "date_format": "system",
  "first_day_of_week": "system",
  "time_format": "system",
  "time_step_minutes": 5
}

403

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}