subject, such as a worker, a time off request, or a
holiday. You can read an event only when you can also read its subject, so an API key or toolset
needs the subject’s read permission as well as calendar.events:read. An event with no subject
needs calendar.events:read alone.
Each upcoming pay period has a payday event and an approval deadline event, about two years ahead.
A payday is an all-day event and already accounts for weekends and bank holidays. An approval
deadline is a single moment: all_day is false and starts and ends are both the deadline.
The title names the event, with the pay schedule when the company has several and the workers when
a pay period has more than one date. The description is one short line: a payday’s pay period, or
the payday a deadline is for.
When all_day is true, treat starts and ends as dates rather than times. A holiday should
render as a full-day event, not as a midnight-to-midnight timed block.
Attributes
string
Unique identifier for the event, for example
cale_K2mP9qR4xL7s.string
The object type. Always
calendar.event.string
Short title shown on the calendar.
string | null
Optional longer description of the event.
string
Timestamp when the event starts.
string
Timestamp when the event ends.
boolean
Whether the event spans the full day. When
true, interpret starts and ends as dates
rather than times.string | null
ID of the record this event projects, such as a worker, leave, holiday, or pay period. Null when the event
has no linked record. Some subjects may not resolve to a public API resource.
object
Set of key-value pairs attached to the event.
string
Timestamp of when the event was created.
string
Timestamp of when the event was last updated.