Skip to main content
Use leave entitlements when you need to see which leave policies currently apply to a worker and when each policy started or ended.

​
Attributes

​
string
Unique identifier for the leave entitlement, for example lve_3vNqM7xRk2pWsT.
​
string
ID of the worker this entitlement belongs to.
​
string
ID of the leave policy applied by this entitlement.
​
string
How the entitlement was created. One of automatic or manual.
​
object
Sparse policy overrides for this worker. Returns an empty object when no fields are overridden.
​
string
ISO 8601 date when the entitlement starts.
​
string | null
ISO 8601 date when the entitlement ends. Returns null for open-ended entitlements.
​
string
ISO 8601 timestamp of when the entitlement was created.
​
string
ISO 8601 timestamp of the most recent update to the entitlement.