v1
latestOpenAPI 3.1.02026-07-243113441.2 MBGet benefits for a company
Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.
Note that company benefits can be deactivated only when no employees are enrolled.
Benefits containing PHI are only visible to applications with the company_benefits:read:phi scope.
scope: company_benefits:read
Path parameters
The UUID of the company
Query parameters
Whether the benefit is currently active
Whether to return employee enrollment count
Filter by benefit type. Comma-separated list of benefit type IDs, i.e. ?benefit_type=5,105
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
Example response