Appearance

List Timeoff balances ​

Endpoint ​

http
GET /unified/hris/timeoff_balances
Integrations supported
  • Charlie
  • HiBob
  • HR Partner
  • Personio
  • Workable

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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
employee
object

This represents the employee the balance belongs to..

Integration specific notes
  • HR PartnerThe employee to filter the time off balances by
  • WorkableThis represents the employee the balance belongs to.
Required in
  • Personio
  • Workable
Supported in
  • Charlie
  • HR Partner
id
string

The unique identifier for employees

name
string

This represents the name of the employee.

timeoff_policy
string

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

Supported in
  • HR Partner
employee_id
string

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

Required in
  • HiBob
timeoff_policy_id
string

The time off policy ID you want to get the time off balances for

Required in
  • HiBob
date
string · date-time

The date for which the time off balance is calculated

Required in
  • HiBob

Response Body ​

result
object[]

List of Timeoff balances

id
string
REQUIRED · 

The unique identifier for time off balances

Supported in
  • Charlie
  • HiBob
  • HR Partner
  • Personio
  • Workable
employee
object

This represents the employee the balance belongs to..

Supported in
  • Charlie
  • HiBob
  • HR Partner
  • Personio
  • Workable
id
string

The unique identifier for employees

name
string

This represents the name of the employee.

timeoff_policy
string

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

Supported in
  • HiBob
  • HR Partner
balance
number

This represents the balance of the time off request.

Supported in
  • Charlie
  • HiBob
  • HR Partner
  • Personio
  • Workable
created_at
string · date-time

This represents the date when the timeoffbalances was created

updated_at
string · date-time

This represents the date when the timeoffbalances was updated

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.