Skip to content

List Benefits

Endpoint

http
GET /unified/hris/benefits
Integrations supported
  • BambooHR
  • Breathe
  • Gusto
  • HR Partner
  • PeopleHR

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
employee
object
Employee associated with this benefit
Required in
  • Breathe
  • Gusto
  • PeopleHR
Supported in
  • HR Partner
id
string
The unique identifier for employees
name
string
This represents the name of the employee
status
string
This represents the status of the benefit
Supported in
  • HR Partner
company_benefit
object
Supported in
  • HR Partner
id
string
The unique identifier for company benefits
name
string
This represents the name of the company benefit
description
string
This represents the description of the company benefit
start_date
string · date-time
This represents the start date of the benefit
Supported in
  • HR Partner
end_date
string · date-time
This represents the end date of the benefit
Supported in
  • HR Partner
employee_id
string
The unique identifier for employees
Required in
  • BambooHR

Response Body

result
object[]
List of Benefits
id
string
REQUIRED · The unique identifier for benefits
Supported in
  • BambooHR
  • Breathe
  • Gusto
  • HR Partner
  • PeopleHR
name
string
The name of the benefit
Supported in
  • BambooHR
  • Breathe
  • HR Partner
  • PeopleHR
employee
object
Employee associated with this benefit
Supported in
  • BambooHR
  • Breathe
  • Gusto
  • HR Partner
  • PeopleHR
id
string
The unique identifier for employees
name
string
This represents the name of the employee
provider_name
string
This represents the provider name
Supported in
  • HR Partner
company_benefit
object
Supported in
  • BambooHR
  • Breathe
  • Gusto
  • HR Partner
id
string
The unique identifier for company benefits
name
string
This represents the name of the company benefit
description
string
This represents the description of the company benefit
employee_contribution
string
This represents the employee contribution
Supported in
  • BambooHR
  • Breathe
  • Gusto
company_contribution
string
This represents the company contribution
Supported in
  • BambooHR
  • Breathe
  • Gusto
  • PeopleHR
currency
string
This represents the currency in which the contribution is made
Supported in
  • BambooHR
start_date
string · date-time
This represents the start date of the benefit
Supported in
  • BambooHR
  • Breathe
  • HR Partner
  • PeopleHR
end_date
string · date-time
This represents the end date of the benefit
Supported in
  • BambooHR
  • Breathe
  • HR Partner
  • PeopleHR
status
string
This represents the status of the benefit
Supported in
  • Gusto
  • HR Partner
created_at
string · date-time
This represents the date when the benefits was created
Supported in
  • Breathe
updated_at
string · date-time
This represents the date when the benefits was updated
Supported in
  • Breathe
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.