Skip to content
GET /unified/hris/timeoff_requests

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

employeeobject

This represents the employee requesting time off.

References: Employees → id
16 supported4 required2 notes
HeavenHR
required
Kenjo
required
PeopleHR
required
Workable
required

This represents the employee the balance belongs to.

HR Partner
supported

The employee to filter the time off requests by

AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
Humaans
supported
Keka
supported
Officient
supported
PeopleForce
supported
Personio
supported
Zoho People
supported
idstring
required·

The unique identifier for employees

namestring

This represents the name of the employee.

timeoff_typestring

The unique identifier for TimeoffType

Possible values:
holidaysickness
12 supported1 required
Breathe
required
AlexisHR
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
Humaans
supported
Keka
supported
Kenjo
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
idstring
start_timestring · date-time

This represents the start time of the time off request.

15 supported3 required
HeavenHR
required
Kenjo
required
PeopleHR
required
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
end_timestring · date-time

This represents the end time of the time off request.

15 supported3 required
HeavenHR
required
Kenjo
required
PeopleHR
required
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
statusstring

This represents the status of the time off request.

Possible values:
APPROVEDPLANNEDREJECTEDREQUESTEDWITHDRAWNallclosedpending
15 supported2 required
HeavenHR
required
PLANNEDAPPROVEDREJECTEDREQUESTEDWITHDRAWN
Kenjo
required
Officient
supported
allpendingclosed
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
timeoff_policy
1 supported
HR Partner
supported
employee_idstring

The employee ID you want to get the time off requests for

2 supported
Humaans
supported
Personio
supported
updated_atstring · date-time

This represents the date when the timeoffpolicies was updated

7 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
Humaans
supported
PeopleForce
supported
Personio
supported
Workable
supported
employee_namestring

The employee number you want to get the time off requests for

1 supported
Zoho People
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

next_cursorstring

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

resultobject[]

List of Timeoff requests

idstring
required·

The unique identifier for timeoffpolicies

16 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
Officient
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Workable
supported
Zoho People
supported
amountnumber

This represents the amount of the time off request.

12 supported
Breathe
supported
Charlie
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Kenjo
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Workable
supported
Zoho People
supported
approverstring

This represents the approver of the time off request.

2 supported
Breathe
supported
Charlie
supported
created_atstring · date-time

This represents the date when the timeoffpolicies was created

8 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
Humaans
supported
Keka
supported
PeopleForce
supported
Personio
supported
Zoho People
supported
descriptionstring

This represents the description of the time off request.

11 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
PeopleForce
supported
Personio
supported
Zoho People
supported
employeeobject

This represents the employee requesting time off.

References: Employees → id
16 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
Officient
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Workable
supported
Zoho People
supported
2 properties
idstring
required·

The unique identifier for employees

namestring

This represents the name of the employee.

employee_notestring

This represents the employee note for the time off request.

2 supported
HR Partner
supported
PeopleHR
supported
end_timestring · date-time

This represents the end time of the time off request.

15 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Workable
supported
Zoho People
supported
reasonobject

This represents the reason of the time off request.

2 supported
Breathe
supported
PeopleHR
supported
2 properties
idstring
required·

The unique identifier for timeoff_reason

namestring

This represents the name of the timeoff_reason.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

request_policy_typestring

This represents the request type of the time off request.

3 supported
Charlie
supported
HiBob
supported
PeopleForce
supported
sessionstring

This represents the session of the time off request.

Possible values:
fullmorningafternoon
5 supported
Breathe
supported
Factorial
supported
HeavenHR
supported
PeopleHR
supported
Personio
supported
start_timestring · date-time

This represents the start time of the time off request.

15 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
PeopleForce
supported
PeopleHR
supported
Personio
supported
Workable
supported
Zoho People
supported
statusstring

This represents the status of the time off request.

15 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
HiBob
supported
HR Partner
supported
Humaans
supported
Keka
supported
Kenjo
supported
Officient
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
timeoff_typestring

This represents the time off type of the time off request.

12 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
Factorial
supported
HeavenHR
supported
Humaans
supported
Keka
supported
Kenjo
supported
PeopleForce
supported
Personio
supported
Workable
supported
Zoho People
supported
unitsstring

This represents the units of the time off request.

Possible values:
hoursdaysweeksmonths
9 supported
AlexisHR
supported
Breathe
supported
Charlie
supported
HiBob
supported
HR Partner
supported
Kenjo
supported
Personio
supported
Workable
supported
Zoho People
supported
updated_atstring · date-time

This represents the date when the timeoffpolicies was updated

7 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
Humaans
supported
PeopleForce
supported
Personio
supported
Workable
supported
curl -X GET 'https://api.truto.one/unified/hris/timeoff_requests?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/timeoff_requests?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/hris/timeoff_requests"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'hris',
  'timeoffrequests',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "hris",
        "timeoffrequests",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())