CHcheckhq

List benefits

Changed on

Returns a list of benefits.

get/benefits

Request

Query parameters

employeestring

Return benefits for this employee ID.

companystring

Return benefits for all employees of this company ID.

limitinteger

Number of benefits returned per page. The maximum value is 500.

include_externalboolean

Flag to indicate if to additionally expose external benefits in the list response. Defaults to false if not included.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

idstring
employeestring
benefitstring
company_benefitunknown
sourceunknown
periodunknown
descriptionstring
effective_startstring
effective_endunknown
company_contribution_amountunknown
company_contribution_percentinteger
company_period_amountunknown
employee_contribution_amountunknown
employee_contribution_percentinteger
employee_period_amountunknown
hsa_contribution_limitunknown
metadataobject

Example response

[
  {
    "id": "ben_lrcYUhTk1FVZl2vSCOBP",
    "employee": "emp_kKTK4VafMNc5pIbI0G9x",
    "benefit": "401k",
    "description": "Guideline 401(k)",
    "effective_start": "2020-01-01",
    "company_contribution_percent": 1,
    "employee_contribution_percent": 1
  }
]

Changes