Skip to content

Get Benefits

Endpoint

http
GET /unified/hris/benefits/{id}
Integrations supported
  • Gusto

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. 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_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

Response Body

id
string
REQUIRED · The unique identifier for benefits
Supported in
  • Gusto
name
string
The name of the benefit
employee
object
Employee associated with this benefit
Supported in
  • Gusto
id
string
The unique identifier for employees
name
string
This represents the name of the employee
provider_name
string
This represents the provider name
company_benefit
object
Supported in
  • Gusto
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
  • Gusto
company_contribution
string
This represents the company contribution
Supported in
  • Gusto
currency
string
This represents the currency in which the contribution is made
start_date
string · date-time
This represents the start date of the benefit
end_date
string · date-time
This represents the end date of the benefit
status
string
This represents the status of the benefit
Supported in
  • Gusto
created_at
string · date-time
This represents the date when the benefits was created
updated_at
string · date-time
This represents the date when the benefits was updated
remote_data
object
Raw data returned from the remote API call.