Skip to main content
GET
/
v1
/
leave-entitlements
List leave entitlements
curl --request GET \
  --url https://api.plane.com/v1/leave-entitlements \
  --header 'Authorization: Bearer <token>'

​
Parameters

​
worker
string
Only return entitlements for this worker ID.
​
policy
string
Only return entitlements for this leave policy ID.
​
type
string
Only return entitlements for this leave type.
​
limit
number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
​
cursor
string
A value from a previous response that lets you fetch the next page.
​
starting_after
string
Return results after this object ID.
​
ending_before
string
Return results before this object ID.

​
Returns

Returns a dictionary with an entitlements property that contains an array of Leave Entitlement objects.