Get Timeoff requests
/unified/hris/timeoff_requests/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
This represents the employee requesting time off.
3 supported3 required2 notes
The employee (employees.id, the Omni user id) whose time-off request to read. Required: Omni HR only exposes this per employee (Omni requires the employee's user id as its user_id parameter). Exactly one employee: employee_id=, employee[id]=, [eq] or [in] with one id, or a one-element array. Several different ids, any other operator or a non-integer id is refused with a 400 (Omni HR has no multi-employee endpoint).
The employee (employees.id, a Workday worker WID, or a reference such as Employee_ID=21001). Required: Workday only exposes this data per worker.
The unique identifier for employees
Resolve the absence's employee, default true. GET /v2/absences/{number} carries no person reference at all, so Truto reads the person whose licence number stands before the underscore of the absence number (one extra GET /v2/persons/{licenseNumber}). That call needs read permission for /persons: when HR WORKS refuses it, the absence is still returned — without employee — instead of the whole read failing with HR WORKS's bare 403. Set false to skip the call entirely (the record then never has employee). Accepts true/false in any letter case, also as [eq]; any other value is read as true, because it can only cost one extra call and can never change which absence is returned. Sick leaves are NOT included: HR WORKS keeps them in a separate endpoint (GET /v2/sick-leaves) with its own types and its own numbering, and the two numbering schemes are not documented to be disjoint, so merging them could give two different records the same id.
1 supported
2 supported2 notes
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The unique identifier for timeoffpolicies
14 supported
This represents the amount of the time off request.
12 supported
This represents the approver of the time off request.
5 supported
This represents the date when the timeoffpolicies was created
8 supported
This represents the description of the time off request.
9 supported
This represents the employee requesting time off.
14 supported
The unique identifier for employees
This represents the name of the employee.
This represents the employee note for the time off request.
8 supported
This represents the end time of the time off request.
13 supported
This represents the reason of the time off request.
3 supported
The unique identifier for timeoff_reason
This represents the name of the timeoff_reason.
Raw data returned from the remote API call.
This represents the request type of the time off request.
6 supported
This represents the session of the time off request.
fullmorningafternoon
6 supported
This represents the start time of the time off request.
14 supported
This represents the status of the time off request.
14 supported
This represents the time off type of the time off request.
12 supported
This represents the units of the time off request.
hoursdaysweeksmonths
12 supported
This represents the date when the timeoffpolicies was updated
6 supported
truto unified hris timeoffrequests '<resource_id>' \
-m get \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.get(
'hris',
'timeoffrequests',
'<resource_id>',
{ 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():
result = await truto_api.unified_api.get(
"hris",
"timeoffrequests",
"<resource_id>",
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/timeoff_requests/{id}?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/{id}?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/{id}"
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())