Data & Sync

Get the account calendar settings

Returns the account-wide calendar defaults every user inherits: whether attendees on calendar events become contacts, whether internal colleagues are skipped in favour of external participants only, and which People record type new contacts are created as. Read-only. A single write here changes behaviour for every user in the account at once — including data residency, retention and who may see whose activity — so these defaults are edited in the app by an administrator and there is no API or CLI write. preferenceOverridePolicy tells you whether they act as defaults each user may change in their own Max settings or as hard settings they cannot. Accepts an account API key, or a USER API key belonging to an OWNER or ADMIN.

get/public/v1/settings/calendar

Response

Account calendar settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "autoCreateContactsMode": "ALL_PARTICIPANTS",
    "peopleSyncRecordTypeId": 1,
    "preferenceOverridePolicy": "NONE"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1