Appearance

List Timeoff balances ​

Endpoint ​

http
GET /unified/hris/timeoff_balances
Integrations supported
  • HiBob

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
  • HiBob
employee
string
This represents the employee the balance belongs to..
Supported in
  • HiBob
timeoff_policy
string
This represents the time off policy of the time off request.
Supported in
  • HiBob
balance
number
This represents the balance of the time off request.
Supported in
  • HiBob
created_at
string
This represents the date when the timeoffbalances was created
updated_at
string
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.