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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
string

Sets a limit on the returned values

​
offset
integer

Offset the returned values

Response

200 - application/json

OK

​
role
string
​
balances
object

Leave balances object