API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Employees

Get employee

client.employees.retrieve(stringemployeeID, RequestOptionsoptions?): Employee { id, active, created_at, 7 more }

get/v1/employees/{employee_id}

Update employee

client.employees.update(stringemployeeID, EmployeeUpdateParams { address, email, employee_class, 3 more } body?, RequestOptionsoptions?): Employee { id, active, created_at, 7 more }

put/v1/employees/{employee_id}

Terminate employee

client.employees.terminate(stringemployeeID, RequestOptionsoptions?): void

delete/v1/employees/{employee_id}

ModelsExpand Collapse

Employee { id, active, created_at, 7 more }

Serializer for Employee entity in public API responses.

Note: Employee is in the company module but exposed via account public API. Contains nested MemberEntity with personal identity information.

id: string

Unique employee identifier with 'empl_' prefix

active: boolean

Whether the employee is currently active

created_at: string

Timestamp when the employee was created

formatdate-time

employer_id: string

ID of the employer this employee works for (empr_*)

member: Member { id, date_of_birth, first_name, 6 more }

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: string

Unique member identifier with 'mbr_' prefix

date_of_birth: string

Member's date of birth (YYYY-MM-DD)

formatdate

first_name: string

Member's legal first name

last_name: string

Member's legal last name

sex: Sex

• Male - Male
• Female - Female
• Other - Other
• Unknown - Unknown

Accepts one of the following:

"Male"

"Female"

"Other"

"Unknown"

email?: string | null

Email address for communications

formatemail

gender?: string | null

Gender identity, if provided

phone?: string | null

Phone number

suffix?: string | null

Name suffix (e.g., Jr., Sr., III)

start_date: string

Employee's start/hire date with the employer

formatdate

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address?: Address | null

Nested address for employee.

city: string

City name

state: string

Two-letter state code

street_1: string

Primary street address

zip_code: string

ZIP code

country?: string

Country code

street_2?: string | null

Secondary street address

employee_class?: EmployeeClass | null

• Full Time - Full Time
• Part Time - Part Time
• Temporary - Temporary
• Intern - Intern
• Seasonal - Seasonal
• Individual Contractor - Individual Contractor

Accepts one of the following:

"Full Time"

"Part Time"

"Temporary"

"Intern"

"Seasonal"

"Individual Contractor"

termination_date?: string | null

Employee's termination date, if terminated

formatdate

EmployeesEnrollments

List employee enrollments

client.employees.enrollments.list(stringemployeeID, EnrollmentListParams { coverage_effective_start_year, limit, page, 2 more } query?, RequestOptionsoptions?): EnrollmentListResponse { id, benefit_product_id, created_at, 13 more }

get/v1/employees/{employee_id}/enrollments

Submit benefit elections

client.employees.enrollments.submitElections(stringemployeeID, EnrollmentSubmitElectionsParams { elections } body, RequestOptionsoptions?): EnrollmentSubmitElectionsResponse { id, benefit_product_id, created_at, 13 more }

post/v1/employees/{employee_id}/enrollments/elect

ModelsExpand Collapse

EnrollmentStatus = "pending" | "enrolled" | "waived" | "inactive"

• pending - Pending
• enrolled - Enrolled
• waived - Waived
• inactive - Inactive

Accepts one of the following:

"pending"

"enrolled"

"waived"

"inactive"