v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List company benefits

get/company_benefits

Query parameters

companystring

Return all company benefits associated with this company ID.

limitinteger

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

Response

200

idstring

companystring

benefitstring

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

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

descriptionstring

effective_startstring

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

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

company_contribution_percentinteger

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

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

employee_contribution_percentinteger

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

metadataobject

Example response

[
  {
    "id": "cbn_lrcYUhTk1FVZl2vSCOBP",
    "company": "cbn_kKTK4VafMNc5pIbI0G9x",
    "benefit": "401k",
    "description": "Guideline 401(k)",
    "effective_start": "2020-01-01",
    "company_contribution_percent": 1,
    "employee_contribution_percent": 1
  }
]