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

​
id
string
Unique identifier for the leave entitlement, for example lve_3vNqM7xRk2pWsT.
​
worker
string
ID of the worker this entitlement belongs to.
​
policy
string
ID of the leave policy applied by this entitlement.
​
source
string
How the entitlement was created. One of automatic or manual.
​
overrides
object
Sparse policy overrides for this worker. Returns an empty object when no fields are overridden.
​
starts
string
ISO 8601 date when the entitlement starts.
​
ends
string | null
ISO 8601 date when the entitlement ends. Returns null for open-ended entitlements.
​
created
string
ISO 8601 timestamp of when the entitlement was created.
​
updated
string
ISO 8601 timestamp of the most recent update to the entitlement.
{
  "id": "lve_3vNqM7xRk2pWsT",
  "worker": "wr_CgcLakmx4guire",
  "policy": "lvp_Xk9mPq2vR8tn3e",
  "source": "manual",
  "overrides": {},
  "starts": "2026-01-01",
  "ends": null,
  "created": "2026-01-01T00:00:00Z",
  "updated": "2026-01-01T00:00:00Z"
}