Benefits
Public API
List Member Benefit Events
Returns benefit enrollment events for all employees and their dependents over the past year, organized by member. Each entry identifies a member (employee or dependent) and lists their per-plan coverage events (eligibility granted, enrolled, or loss of coverage), sorted chronologically. Requires benefit settings access.
OAuth Scopes: benefit
get/api/v1/benefit/member_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 members array of member benefit event records.
Changes
No recorded changes to this operation across all 2 revisions of this API.