API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Employees

Get employee

employees.retrieve(stremployee_id) -> Employee

get/v1/employees/{employee_id}

Update employee

employees.update(stremployee_id, EmployeeUpdateParams**kwargs) -> Employee

put/v1/employees/{employee_id}

Terminate employee

employees.terminate(stremployee_id)

delete/v1/employees/{employee_id}

ModelsExpand Collapse

class Employee: …

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: str

Unique employee identifier with 'empl_' prefix

active: bool

Whether the employee is currently active

created_at: datetime

Timestamp when the employee was created

formatdate-time

employer_id: str

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

member: Member

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: str

Unique member identifier with 'mbr_' prefix

date_of_birth: date

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

formatdate

first_name: str

Member's legal first name

last_name: str

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: Optional[str]

Email address for communications

formatemail

gender: Optional[str]

Gender identity, if provided

phone: Optional[str]

Phone number

suffix: Optional[str]

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

start_date: date

Employee's start/hire date with the employer

formatdate

updated_at: datetime

Timestamp when the employee was last updated

formatdate-time

address: Optional[Address]

Nested address for employee.

city: str

City name

state: str

Two-letter state code

street_1: str

Primary street address

zip_code: str

ZIP code

country: Optional[str]

Country code

street_2: Optional[str]

Secondary street address

employee_class: Optional[EmployeeClass]

• 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: Optional[date]

Employee's termination date, if terminated

formatdate

EmployeesEnrollments

List employee enrollments

employees.enrollments.list(stremployee_id, EnrollmentListParams**kwargs) -> EnrollmentListResponse

get/v1/employees/{employee_id}/enrollments

Submit benefit elections

employees.enrollments.submit_elections(stremployee_id, EnrollmentSubmitElectionsParams**kwargs) -> EnrollmentSubmitElectionsResponse

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

ModelsExpand Collapse

EnrollmentStatus = Literal["pending", "enrolled", "waived", "inactive"]

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

Accepts one of the following:

"pending"

"enrolled"

"waived"

"inactive"