GET Leave Requests

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

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

fetch('https://api.rippling.com/platform/api/leave_requests', 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_requests",
  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_requests"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.rippling.com/platform/api/leave_requests")

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

[
  {
    "id": "5b998dfb40cae798a83e8874",
    "createdAt": "2018-08-12T15:06:51.681000-07:00",
    "updatedAt": "2018-08-13T15:06:51.684000-07:00",
    "role": "5ae0b2cb40cae73202bd66cc",
    "roleName": "Jane Doe",
    "requestedBy": "5ae0b2cb40cae73202bd66cc",
    "requestedByName": "Jane Doe",
    "status": "APPROVED",
    "startDate": "2018-08-22",
    "endDate": "2018-08-24",
    "startDateStartTime": "2018-08-22T12:00:00.235000-07:00",
    "endDateEndTime": "2018-08-24T15:00:00.235000-07:00",
    "startDateCustomHours": 8,
    "endDateCustomHours": 4,
    "comments": null,
    "numHours": 20,
    "numMinutes": 1200,
    "leavePolicy": "5b998cf940cae798a83e87fd",
    "leaveType": "VACATION",
    "policyDisplayName": "Vacation",
    "processedAt": "2018-08-13T15:06:51.684000-07:00",
    "processedBy": "5ae0b2cb40cae73202bd66cc",
    "processedByName": "Funky Admin",
    "reasonForLeave": "Visiting hometown for my brother’s wedding",
    "externalId": "qwerty12345",
    "roleTimezone": "America/Los_Angeles",
    "dates": [
      {
        "date": "2018-08-22",
        "numMinutes": 480
      },
      {
        "date": "2018-08-23",
        "numMinutes": 480
      },
      {
        "date": "2018-08-24",
        "numMinutes": 240
      }
    ]
  }
]

GET

platform

api

leave_requests

GET Leave Requests

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

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

fetch('https://api.rippling.com/platform/api/leave_requests', 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_requests",
  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_requests"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.rippling.com/platform/api/leave_requests")

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

[
  {
    "id": "5b998dfb40cae798a83e8874",
    "createdAt": "2018-08-12T15:06:51.681000-07:00",
    "updatedAt": "2018-08-13T15:06:51.684000-07:00",
    "role": "5ae0b2cb40cae73202bd66cc",
    "roleName": "Jane Doe",
    "requestedBy": "5ae0b2cb40cae73202bd66cc",
    "requestedByName": "Jane Doe",
    "status": "APPROVED",
    "startDate": "2018-08-22",
    "endDate": "2018-08-24",
    "startDateStartTime": "2018-08-22T12:00:00.235000-07:00",
    "endDateEndTime": "2018-08-24T15:00:00.235000-07:00",
    "startDateCustomHours": 8,
    "endDateCustomHours": 4,
    "comments": null,
    "numHours": 20,
    "numMinutes": 1200,
    "leavePolicy": "5b998cf940cae798a83e87fd",
    "leaveType": "VACATION",
    "policyDisplayName": "Vacation",
    "processedAt": "2018-08-13T15:06:51.684000-07:00",
    "processedBy": "5ae0b2cb40cae73202bd66cc",
    "processedByName": "Funky Admin",
    "reasonForLeave": "Visiting hometown for my brother’s wedding",
    "externalId": "qwerty12345",
    "roleTimezone": "America/Los_Angeles",
    "dates": [
      {
        "date": "2018-08-22",
        "numMinutes": 480
      },
      {
        "date": "2018-08-23",
        "numMinutes": 480
      },
      {
        "date": "2018-08-24",
        "numMinutes": 240
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

string

role

string

requestedBy

string

status

string

startDate

string

Start date of leave.

endDate

string

End date of leave.

leavePolicy

string

processedBy

string

from

string

Filter to capture whether the leave request overlaps with a date range.

string

Filter to capture whether the leave request overlaps with a date range.

limit

string

Sets a limit on the returned values

offset

string

Offsets the returned values

Response

200 - application/json

string

Unique identifier of the leave request.

createdAt

string

updatedAt

string

role

string

Unique identifier of the employee who is taking leave.

roleName

string

requestedBy

string | null

requestedByName

string | null

Unique identifier of the employee who made the request (in most cases this is the same as role).

status

enum<string>

Available options:

PENDING,

APPROVED,

REJECTED,

CANCELED

startDate

string

endDate

string

startDateStartTime

string | null

endDateEndTime

string | null

startDateCustomHours

string | null

endDateCustomHours

string | null

comments

string | null

numHours

integer | null

numMinutes

integer | null

leavePolicy

string

leaveTypeUniqueId

enum<string>

Available options:

VACATION,

SICK,

JURY_DUTY

policyDisplayName

string

reasonForLeave

string | null

processedAt

string | null

processedBy

string | null

Unique identifier of the employee who approved or rejected the request. This may be null.

processedByName

string | null

roleTimezone

string | null

Timezone of the role. This will be work location timezone, or home timezone for employees without a work location.

dates

object[]

Show child attributes

isPaid

boolean

If the leave request is paid this will be TRUE. Otherwise, this will be FALSE.

managedBy

enum<string>

This indicates the system that manages the Leave Request. PTO = managed by Rippling's Time Off app. LEAVES = managed by Rippling's Leave Management app. TILT = managed by third-party partner Tilt.

Available options:

PTO,

LEAVES,

TILT

partialDays

(object | null)[]

Show child attributes

A. Companies

B. Employees

E. Current User

F. Groups

J. Leaves

G. SAML

H. ATS

I. Application Management

GET Leave Requests

Authorizations

Query Parameters

Response