List company benefits
Changed onList company benefits
get/company_benefits
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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.
idstring[]
Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.
Response
200
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
}
]Changes
- info
added the new optional
queryrequest parameterid
- info