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

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

​
worker
string
Only return balances for this worker ID.
​
policy
string
Only return balances for this leave policy ID.
​
type
string
Only return balances 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 a balances property that contains an array of Leave Balance objects.