Skip to content

List Timeoff requests

Endpoint

http
GET /unified/hris/timeoff_requests
Integrations supported
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • Officient
  • PeopleHR
  • Personio
  • Zoho People
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Officient

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. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
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_limit
boolean
Ignores the `limit` query parameter.
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.
Example: remote_query[foo]=bar
status
string
This represents the status of the time off request.
All possible enum values:
  • APPROVED
  • PLANNED
  • REJECTED
  • REQUESTED
  • WITHDRAWN
  • all
  • closed
  • pending
Enum support by integration
  • Officient
    • all
    • pending
    • closed
  • HeavenHR
    • PLANNED
    • APPROVED
    • REJECTED
    • REQUESTED
    • WITHDRAWN
Required in
  • HeavenHR
  • Kenjo
Supported in
  • HR Partner
  • Officient
employee
object
The employee to filter the time off requests by
Required in
  • HeavenHR
  • Kenjo
  • PeopleHR
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Partner
id
string
REQUIRED · The unique identifier for employee
name
string
This represents the name of the employee.
start_time
string · date-time
This represents the start time of the time off request.
Required in
  • HeavenHR
  • Kenjo
  • PeopleHR
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HiBob
  • HR Partner
  • Humaans
  • Personio
end_time
string · date-time
This represents the end time of the time off request.
Required in
  • HeavenHR
  • Kenjo
  • PeopleHR
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HiBob
  • Humaans
  • Personio
timeoff_policy
Supported in
  • HR Partner
timeoff_type
object
This represents the time off type of the time off request.
All possible enum values:
  • holiday
  • sickness
Required in
  • Breathe
Supported in
  • AlexisHR
  • Factorial
  • Humaans
id
string
employee_name
string
The employee number you want to get the time off requests for
Supported in
  • Zoho People
employee_id
string
The employee ID you want to get the time off requests for
Supported in
  • Humaans
  • Personio
updated_at
string · date-time
This represents the date when the timeoffpolicies was updated
Supported in
  • Personio

Response Body

result
object[]
List of Timeoff requests
id
string
REQUIRED · The unique identifier for timeoffpolicies
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • Officient
  • PeopleHR
  • Personio
  • Zoho People
description
string
This represents the description of the time off request.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • Personio
  • Zoho People
reason
object
This represents the reason of the time off request.
Supported in
  • Breathe
  • PeopleHR
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.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • Officient
  • PeopleHR
  • Personio
  • Zoho People
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
  • Breathe
  • Charlie
status
string
This represents the status of the time off request.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • Officient
  • Personio
  • Zoho People
employee_note
string
This represents the employee note for the time off request.
Supported in
  • HR Partner
  • PeopleHR
units
string
This represents the units of the time off request.
All possible enum values:
  • hours
  • days
  • weeks
  • months
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • HiBob
  • HR Partner
  • Kenjo
  • Personio
  • Zoho People
amount
number
This represents the amount of the time off request.
Supported in
  • Breathe
  • Charlie
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Kenjo
  • PeopleHR
  • Personio
  • Zoho People
timeoff_type
string
This represents the time off type of the time off request.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • Humaans
  • Keka
  • Kenjo
  • Personio
  • Zoho People
request_policy_type
string
This represents the request type of the time off request.
Supported in
  • Charlie
  • HiBob
start_time
string · date-time
This represents the start time of the time off request.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • PeopleHR
  • Personio
  • Zoho People
end_time
string · date-time
This represents the end time of the time off request.
Supported in
  • AlexisHR
  • Breathe
  • Charlie
  • Factorial
  • HeavenHR
  • HiBob
  • HR Partner
  • Humaans
  • Keka
  • Kenjo
  • PeopleHR
  • Personio
  • Zoho People
session
string
This represents the session of the time off request.
All possible enum values:
  • full
  • morning
  • afternoon
Supported in
  • Breathe
  • Factorial
  • HeavenHR
  • PeopleHR
  • Personio
created_at
string · date-time
This represents the date when the timeoffpolicies was created
Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Humaans
  • Keka
  • Personio
  • Zoho People
updated_at
string · date-time
This represents the date when the timeoffpolicies was updated
Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Humaans
  • Personio
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
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.