Docs »

Records »

Types »

Worker

Name (singular): Worker
Name (plural): Workers
Alias (uri): worker
Identifier (ID): cerberusweb.contexts.worker

Records API

These fields are available in the Records API and packages:

Req’d Field Type Notes
  at_mention_name text The nickname used for @mention notifications in comments
  calendar_id number The ID of the calendar used to compute worker availability
  dob text Date of birth in YYYY-MM-DD format
  email text The primary email address of the worker; alternative to email_id
x email_id number The ID of the primary email address; alternative to email
  email_ids text A comma-separated list of IDs for alternative email addresses
x first_name text Given name
  gender text F (female), M (male), or blank or unknown
  image image The worker’s profile picture in PNG format
  is_disabled boolean Is this worker deactivated and prevented from logging in?
  is_mfa_required boolean Is this worker required to use multi-factor authentication?
  is_password_disabled boolean Is this worker allowed to log in with a password?
  is_superuser boolean Is this worker an administrator with full privileges?
x language text ISO-639 language code and ISO-3166 country code; e.g. en_US
  last_name text Surname
  links links An array of record type:id tuples to link to
  location text Location description; Los Angeles, CA, USA
  mobile text Mobile number
  password text The worker’s password, if applicable; stored security; will be automatically generated if blank
  phone text  
  time_format text Preference for displaying timestamps, strftime() syntax
x timezone text IANA tz/zoneinfo timezone; America/Los_Angeles
  title text Job title / Position
  updated timestamp The date/time when this record was last modified

Dictionary Placeholders

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

Field Type Description
_label text Label
address_ record Email
at_mention_name text @Mention
calendar_ record Calendar
calendar_owner_ record Calendar Owner
dob text Date Of Birth
first_name text First Name
full_name text Full Name
gender text Gender
id worker Id
is_disabled boolean Disabled
is_superuser boolean Administrator
language text Language
last_name text Last Name
location text Location
mobile phone Mobile
phone phone Phone
record_url text Record Url
time_format text Time Format
timezone text Timezone
title text Title
updated date Updated

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

Field Type Description
custom_<id> mixed Custom Fields
links links Links

Search Query Fields

These filters are available in worker search queries:

Field Type Description
alias: virtual Aliases
email: record Email
email.id: chooser Email
fieldset: record Fieldset
firstName: text First Name
gender: text Gender
group: record Groups
group.manager: record Group Manager
id: number Id
isAdmin: boolean Administrator
isAvailable: virtual Calendar Availability
isBusy: virtual Calendar Availability
isDisabled: boolean Disabled
isMfaRequired: boolean Mfa Required
isPasswordDisabled: boolean Password Disabled
language: text Language
lastActivity: date Last Activity
lastName: text Last Name
links: links Record Links
location: text Location
mention: text @Mention
mobile: text Mobile
phone: text Phone
role: record Role
role.editor: record Role Editor
role.reader: record Role Reader
timezone: text Timezone
title: text Title
updated: date Updated

Worklist Columns

These columns are available on worker worklists:

Column Description
*_calendar_availability Calendar Availability
a_address_email Email Address
cf_<id> Custom Field
w_at_mention_name @Mention
w_calendar_id Calendar
w_dob D.o.b.
w_first_name First Name
w_gender Gender
w_id Id
w_is_disabled Disabled
w_is_mfa_required Mfa Required
w_is_password_disabled Password Disabled
w_is_superuser Administrator
w_language Language
w_last_name Last Name
w_location Location
w_mobile Mobile
w_phone Phone
w_time_format Time Format
w_timezone Timezone
w_title Title
w_updated Updated