v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List benefits

Returns a list of benefits.

get/benefits

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.

Response

200

idstring

employeestring

benefitstring

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:company_benefit","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:source","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:period","oasType":"schema","type":"unknown"}

descriptionstring

effective_startstring

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:effective_end","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:company_contribution_amount","oasType":"schema","type":"unknown"}

company_contribution_percentinteger

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:company_period_amount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:employee_contribution_amount","oasType":"schema","type":"unknown"}

employee_contribution_percentinteger

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:employee_period_amount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/benefits:get:responses:200:content:application/json:schema:items:properties:hsa_contribution_limit","oasType":"schema","type":"unknown"}

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
  }
]