Employees

Get employee

employees.retrieve(employee_id) -> Employee { id, active, created_at, 7 more }

get/v1/employees/{employee_id}

Update employee

employees.update(employee_id, **kwargs) -> Employee { id, active, created_at, 7 more }

put/v1/employees/{employee_id}

Terminate employee

employees.terminate(employee_id) -> void

delete/v1/employees/{employee_id}

ModelsExpand Collapse

class 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: bool

Whether the employee is currently active

created_at: Time

Timestamp when the employee was created

formatdate-time

employer_id: String

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

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

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

Email address for communications

formatemail

gender: String

Gender identity, if provided

phone: String

Phone number

suffix: String

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

start_date: Date

Employee's start/hire date with the employer

formatdate

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { city, state, street_1, 3 more}

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

Secondary street address

employee_class: 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: Date

Employee's termination date, if terminated

formatdate

EmployeesEnrollments

List employee enrollments

employees.enrollments.list(employee_id, **kwargs) -> EnrollmentListResponse { id, benefit_product_id, created_at, 13 more }

get/v1/employees/{employee_id}/enrollments

Submit benefit elections

employees.enrollments.submit_elections(employee_id, **kwargs) -> 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