API Reference
Libraries
API Overview
Auth
Issue short-lived access tokens for scoped API access
Issue access token
POST/v1/auth/access-tokens
Benefit Eligibility Policies
Define rules that determine which employees qualify for benefits
Get eligibility policy details
GET/v1/benefit-eligibility-policies/{policy_id}
Employees
Get employee
GET/v1/employees/{employee_id}
List employee enrollments
GET/v1/employees/{employee_id}/enrollments
Employers
List employers
GET/v1/employers
Create employer
POST/v1/employers
Get employer
GET/v1/employers/{employer_id}
Create eligibility policy
POST/v1/employers/{employer_id}/benefit-eligibility-policies
Submit census sync
POST/v1/employers/{employer_id}/census-sync
List employees
GET/v1/employers/{employer_id}/employees
Update employer settings
PUT/v1/employers/{employer_id}/settings
Enrollments
Manage benefit enrollments and elections for employees
Get enrollment details
GET/v1/enrollments/{enrollment_id}
Webhook Events
List webhook events
GET/v1/webhook-events
Get webhook event
GET/v1/webhook-events/{event_id}
List webhook event deliveries
GET/v1/webhook-events/{event_id}/deliveries
Groups
List groups
GET/v1/groups
Create group
POST/v1/groups
Get group
GET/v1/groups/{group_id}
Update group
PATCH/v1/groups/{group_id}
GroupsMembers
GroupsMembersSync
Submit group member sync
POST/v1/groups/{group_id}/members/sync
Get group member sync request
GET/v1/groups/{group_id}/members/sync/{request_id}
Plans
List organization plans
GET/v1/plans