Appearance

Get Timeoff requests ​

Endpoint ​

http
GET /unified/hris/timeoff_requests/{id}
Integrations supported
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Officient
  • Personio

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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
employee
object

This represents the employee requesting time off.

Required in
  • HiBob
id
string
REQUIRED · 

The unique identifier for employees

name
string

This represents the name of the employee.

Response Body ​

id
string
REQUIRED · 

The unique identifier for timeoffpolicies

Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Officient
  • Personio
description
string

This represents the description of the time off request.

Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • Personio
reason
object

This represents the reason of the time off request.

id
string
REQUIRED · 

The unique identifier for timeoff_reason

name
string

This represents the name of the timeoff_reason.

employee
object

This represents the employee requesting time off.

References: Employees → id
Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Officient
  • Personio
id
string
REQUIRED · 

The unique identifier for employees

name
string

This represents the name of the employee.

approver
string

This represents the approver of the time off request.

Supported in
  • Charlie
status
string

This represents the status of the time off request.

Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Officient
  • Personio
employee_note
string

This represents the employee note for the time off request.

units
string

This represents the units of the time off request.

All possible enum values:
  • hours
  • days
  • weeks
  • months
Supported in
  • AlexisHR
  • Charlie
  • HiBob
  • Personio
amount
number

This represents the amount of the time off request.

Supported in
  • Charlie
  • HiBob
  • Officient
  • Personio
timeoff_type
string

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

References: TimeoffTypes → id
Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • Personio
request_policy_type
string

This represents the request type of the time off request.

Supported in
  • Charlie
  • HiBob
  • Officient
start_time
string · date-time

This represents the start time of the time off request.

Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Officient
  • Personio
end_time
string · date-time

This represents the end time of the time off request.

Supported in
  • AlexisHR
  • Charlie
  • Factorial
  • HiBob
  • Personio
session
string

This represents the session of the time off request.

All possible enum values:
  • full
  • morning
  • afternoon
Supported in
  • Factorial
  • Personio
created_at
string · date-time

This represents the date when the timeoffpolicies was created

Supported in
  • AlexisHR
  • Factorial
  • Personio
updated_at
string · date-time

This represents the date when the timeoffpolicies was updated

Supported in
  • AlexisHR
  • Factorial
  • Personio
remote_data
object

Raw data returned from the remote API call.