Skip to main content
GET
/
platform
/
api
/
leave_balances
/
{role}
GET Leave Balance
curl --request GET \
  --url https://api.rippling.com/platform/api/leave_balances/{role} \
  --header 'Authorization: Bearer <token>'
{
  "role": "583fd880a7b6897c1ed03604",
  "balances": [
    {
      "companyLeaveType": "639b3abdfb9a2a208aeb3ceb",
      "isBalanceUnlimited": true
    },
    {
      "companyLeaveType": "639b3abdfb9a2a208aeb3ce7",
      "isBalanceUnlimited": true
    },
    {
      "companyLeaveType": "583fd8cfa7b6897c1ed034a7",
      "balanceWithFutureRequests": "13637.26",
      "balanceWithoutFutureRequests": "16997.26",
      "isBalanceUnlimited": false
    },
    {
      "companyLeaveType": "583fd8cfa7b6897c1ed034a9",
      "balanceWithFutureRequests": "11331.51",
      "balanceWithoutFutureRequests": "11331.51",
      "isBalanceUnlimited": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
role
string
required

This is the unique role ID of the employee. It corresponds to the IDs returned in the Get/employees endpoint

Response

200 - application/json

OK

​
role
string
​
balances
object

Leave balances object