API Reference
Libraries
API Overview
Auth
Issue short-lived access tokens for scoped API access
Issue access token
POST/v1/auth/access-tokens
Employees
Get employee
GET/v1/employees/{employee_id}
Update employee
PATCH/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}
Update employer
PUT/v1/employers/{employer_id}
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
List HRIS providers
GET/v1/employers/hris-providers
Get an employer's HRIS connection
GET/v1/employers/{employer_id}/hris
List an employer's benefit plan years
GET/v1/employers/{employer_id}/benefit-plan-years
Get one of an employer's benefit plan years
GET/v1/employers/{employer_id}/benefit-plan-years/{benefit_plan_year_id}
List a benefit plan year's enrollments
GET/v1/employers/{employer_id}/benefit-plan-years/{benefit_plan_year_id}/enrollments
List an employer's billing invoices
GET/v1/employers/{employer_id}/invoices
Get an employer invoice's PDF download link
GET/v1/employers/{employer_id}/invoices/{invoice_id}/pdf
Retrieve Payroll Access Setup
GET/v1/employers/{employer_id}/payroll-access-setup
Submit Payroll Access Setup
PUT/v1/employers/{employer_id}/payroll-access-setup
List an employer's payroll-deduction statements
GET/v1/employers/{employer_id}/payroll-deduction-statements
Ensure Payroll Integration Email
PUT/v1/employers/{employer_id}/payroll-integration-email
Enrollments
Manage benefit enrollments and elections for employees
Get enrollment details
GET/v1/enrollments/{enrollment_id}
Reissue an enrollment
POST/v1/enrollments/{enrollment_id}/reissue
Terminate an enrollment
POST/v1/enrollments/{enrollment_id}/terminate
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}
Members
Browse the members covered across your book and read a member’s profile
List members
GET/v2/members
Get member
GET/v1/members/{member_id}
List member dependents
GET/v1/members/{member_id}/dependents
List member employments
GET/v1/members/{member_id}/employments
List member enrollments
GET/v1/members/{member_id}/enrollments
Get member household
GET/v1/members/{member_id}/household
List member ID cards
GET/v1/members/{member_id}/id-cards
List member qualifying life events
GET/v1/members/{member_id}/qualifying-life-events
Organizations
List my organizations
GET/v1/organizations
Create organization
POST/v1/organizations
Plans
List organization plans
GET/v1/plans