Docs »

Records »

Types »


Name (singular): Calendar
Name (plural): Calendars
Alias (uri): calendar
Identifier (ID): cerberusweb.contexts.calendar

Records API

These fields are available in the Records API and packages:

Req’d Field Type Notes
  links links An array of record type:id tuples to link to. Prefix with - to unlink.
x name text The name of this calendar
x owner__context context The record type of this calendar’s owner: app, role, group, or worker
x owner_id number The ID of this calendar’s owner
  params object JSON-encoded key/value object
  timezone text  
  updated_at timestamp The date/time when this record was last modified


Key Value
color_available The hex color code for available events (e.g. #a0d95b)
color_busy The hex color code for busy events (e.g. #c8c8c8)
hide_start_time 0 to show event start times, 1 to disable
manual_disabled 0 to enable manual event creation, 1 to disable
series An optional array of series objects
start_on_mon 0 to start weeks on Sunday, 1 to start on Monday
sync_enabled 0 to disable event synchronization, 1 to enable


Key Value
datasource calendar.datasource.worklist

Dictionary Placeholders

These placeholders are available in dictionaries for automations, snippets, and API responses:

Field Type Description
_context text Record type extension ID
_label text Label
_type text Record type alias
id number Id
name text Name
owner_ record Owner
record_url text Record Url
timezone text Timezone
updated_at date Updated

These optional placeholders are also available with key expansion in dictionaries and the API:

Field Type Description
comment_count number Comment count on the record
comments comments Comments
custom_<id> mixed Custom Fields
events   Events
events_occluded   Events (Occluded)
links links Links
scope   Scope
watchers watchers Watchers
weeks   Weeks
weeks_events   Weeks Events
weeks_events_occluded   Weeks Events (Occluded)

Search Query Fields

These filters are available in calendar search queries:

Field Type Description
fieldset: record Fieldset
id: number Id
links: links Record Links
name: text Name
owner: virtual Owner virtual Owner record Owner record Owner
owner.role: record Owner
owner.worker: record Owner
timezone: text Timezone
updated: date Updated
watchers: record Watchers
workerAvailability: record Workers

Worklist Columns

These columns are available on calendar worklists:

Column Description
*_owner Owner
c_id Id
c_name Name
c_timezone Timezone
c_updated_at Updated
cf_<id> Custom Field