Benefits
Public API
List Company Benefits
Changed onReturns all active (non-deleted) company benefit plans for the account. Each plan includes summary-level fields such as name, benefit category type, associated vendor and deduction IDs, effective date range, and catch-up eligibility flags. Deleted plans are excluded. To retrieve full detail for a specific plan (including SSO URL, description, and ACA fields), use "Get a company benefit".
OAuth Scopes: benefit
get/api/v1/benefit/company_benefit
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesbenefit
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
An object containing a companyBenefits array of benefit plan summaries.
Changes
- info
added the non-success response with the status
- info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status
- info