Skip to main content
GET
List leave balances

Parameters

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

Returns

Returns a dictionary with a balances property that contains an array of Leave Balance objects.