GET Leave Balance

Retrieves the leave balances for a given role. A role represents 1 employee. An employee can work at 1 and only 1 company.

GET /platform/api/leave_balances/{role}

GET Leave Balance

cURL

curl --request GET \
  --url https://api.rippling.com/platform/api/leave_balances/{role} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rippling.com/platform/api/leave_balances/{role}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rippling.com/platform/api/leave_balances/{role}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rippling.com/platform/api/leave_balances/{role}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rippling.com/platform/api/leave_balances/{role}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rippling.com/platform/api/leave_balances/{role}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rippling.com/platform/api/leave_balances/{role}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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 · LeaveBalances · object

Leave balances object

Show child attributes