Playground

Playground

CalendarEvent

/api/v1/employee/calendar-events

A calendar entry for a Person.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
organizer_iduuidUUID of the Person who created or owns this event.
attendee_idsjsonUUIDs of Person records attending this event.
typestringClassification of the event. 'ooo' = out of office, 'focus_time' = blocked for deep work.
titlestringHuman-readable title for the event.
descriptionstringOptional description or agenda for the event.
startdate-timeISO 8601 timestamp when the event starts.
enddate-timeISO 8601 timestamp when the event ends.
is_all_daybooleanTrue if the event spans the full day and has no specific time bounds.
locationstringPhysical location or room name for the event.
video_urlstringURL for the video conferencing link (e.g., Zoom, Google Meet, Teams).
linked_project_iduuidUUID of the Project this event is associated with.
linked_task_idsjsonUUIDs of Task records discussed or actioned in this event.
statusstringAttendance or booking status for the event.

API

client.employee.calendarEvents.*
Loading manifest…