API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Employees

Get employee

employees.retrieve(employee_id) -> EmployeeRetrieveResponse { data }

GET/v1/employees/{employee_id}

Update employee

employees.update(employee_id, **kwargs) -> EmployeeUpdateResponse { data }

PATCH/v1/employees/{employee_id}

List employee enrollments

employees.list_enrollments(employee_id, **kwargs) -> PageNumberPage<Enrollment { id, answered_at, benefit, 10 more } >

GET/v1/employees/{employee_id}/enrollments

ModelsExpand Collapse

class Employee { id, classification_effective_date, compensation_type, 20 more }

id: String

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: Date

Date the employee’s current classification took effect

formatdate

compensation_type: :Salary | :Hourly

• Salary - Salary
• Hourly - Hourly

One of the following:

:Salary

:Hourly

compensation_type_effective_date: Date

Date the employee’s current compensation type took effect

formatdate

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array[{ benefit_name, deduction_amount_in_cents, deduction_category, 4 more}]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: String

Name of the benefit plan

deduction_amount_in_cents: Integer

Employee deduction amount in cents

deduction_category: String

Deduction category (reserved for future use)

frequency: :weekly | :bi_weekly | :semi_monthly | :monthly

• weekly - Weekly
• bi_weekly - Bi Weekly
• semi_monthly - Semi Monthly
• monthly - Monthly

One of the following:

:weekly

:bi_weekly

:semi_monthly

:monthly

period_end_date: Date

Period end date (YYYY-MM-DD)

formatdate

period_start_date: Date

Period start date (YYYY-MM-DD)

formatdate

tax_classification: :Unknown | :"Pre-tax" | :"Post-tax"

• Unknown - Unknown
• Pre-tax - Pre Tax
• Post-tax - Post Tax

One of the following:

:Unknown

:"Pre-tax"

:"Post-tax"

email: String

Email address

formatemail

employee_class: EmployeeClass

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

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

employer_id: String

Unique identifier of the employer this employment is with (empr_*)

first_name: String

Employee’s legal first name

last_name: String

Employee’s legal last name

member_id: String

Unique member identifier with ‘mbr_’ prefix

phone: String

Phone number (10-digit US domestic string)

start_date: Date

Employee’s start date with the employer

formatdate

status: :active | :terminated

Employee status (active or terminated)

One of the following:

:active

:terminated

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { address_line_1, city, state, 2 more}

Employee’s residential address

address_line_1: String

Primary street address

city: String

City name

state: String

Two-letter state code (e.g., CA, NY)

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

employer_name: String

Name of the employer this employment is with

gender: String

Gender identity, if provided

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

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

termination_date: Date

Employee’s termination date, if terminated

formatdate

EmployeeClass = :"Full Time" | :"Part Time" | :Temporary | 3 more

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

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

class Pagination { limit, page, total, total_pages }

Pagination metadata for list responses.

limit: Integer

Items per page

page: Integer

Current page number

total: Integer

Total number of items

total_pages: Integer

Total number of pages

class EmployeeRetrieveResponse { data }

Response containing a single employee resource.

data: Employee { id, classification_effective_date, compensation_type, 20 more }

id: String

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: Date

Date the employee’s current classification took effect

formatdate

compensation_type: :Salary | :Hourly

• Salary - Salary
• Hourly - Hourly

One of the following:

:Salary

:Hourly

compensation_type_effective_date: Date

Date the employee’s current compensation type took effect

formatdate

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array[{ benefit_name, deduction_amount_in_cents, deduction_category, 4 more}]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: String

Name of the benefit plan

deduction_amount_in_cents: Integer

Employee deduction amount in cents

deduction_category: String

Deduction category (reserved for future use)

frequency: :weekly | :bi_weekly | :semi_monthly | :monthly

• weekly - Weekly
• bi_weekly - Bi Weekly
• semi_monthly - Semi Monthly
• monthly - Monthly

One of the following:

:weekly

:bi_weekly

:semi_monthly

:monthly

period_end_date: Date

Period end date (YYYY-MM-DD)

formatdate

period_start_date: Date

Period start date (YYYY-MM-DD)

formatdate

tax_classification: :Unknown | :"Pre-tax" | :"Post-tax"

• Unknown - Unknown
• Pre-tax - Pre Tax
• Post-tax - Post Tax

One of the following:

:Unknown

:"Pre-tax"

:"Post-tax"

email: String

Email address

formatemail

employee_class: EmployeeClass

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

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

employer_id: String

Unique identifier of the employer this employment is with (empr_*)

first_name: String

Employee’s legal first name

last_name: String

Employee’s legal last name

member_id: String

Unique member identifier with ‘mbr_’ prefix

phone: String

Phone number (10-digit US domestic string)

start_date: Date

Employee’s start date with the employer

formatdate

status: :active | :terminated

Employee status (active or terminated)

One of the following:

:active

:terminated

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { address_line_1, city, state, 2 more}

Employee’s residential address

address_line_1: String

Primary street address

city: String

City name

state: String

Two-letter state code (e.g., CA, NY)

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

employer_name: String

Name of the employer this employment is with

gender: String

Gender identity, if provided

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

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

termination_date: Date

Employee’s termination date, if terminated

formatdate

class EmployeeUpdateResponse { data }

Response containing a single employee resource.

data: Employee { id, classification_effective_date, compensation_type, 20 more }

id: String

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: Date

Date the employee’s current classification took effect

formatdate

compensation_type: :Salary | :Hourly

• Salary - Salary
• Hourly - Hourly

One of the following:

:Salary

:Hourly

compensation_type_effective_date: Date

Date the employee’s current compensation type took effect

formatdate

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array[{ benefit_name, deduction_amount_in_cents, deduction_category, 4 more}]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: String

Name of the benefit plan

deduction_amount_in_cents: Integer

Employee deduction amount in cents

deduction_category: String

Deduction category (reserved for future use)

frequency: :weekly | :bi_weekly | :semi_monthly | :monthly

• weekly - Weekly
• bi_weekly - Bi Weekly
• semi_monthly - Semi Monthly
• monthly - Monthly

One of the following:

:weekly

:bi_weekly

:semi_monthly

:monthly

period_end_date: Date

Period end date (YYYY-MM-DD)

formatdate

period_start_date: Date

Period start date (YYYY-MM-DD)

formatdate

tax_classification: :Unknown | :"Pre-tax" | :"Post-tax"

• Unknown - Unknown
• Pre-tax - Pre Tax
• Post-tax - Post Tax

One of the following:

:Unknown

:"Pre-tax"

:"Post-tax"

email: String

Email address

formatemail

employee_class: EmployeeClass

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

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

employer_id: String

Unique identifier of the employer this employment is with (empr_*)

first_name: String

Employee’s legal first name

last_name: String

Employee’s legal last name

member_id: String

Unique member identifier with ‘mbr_’ prefix

phone: String

Phone number (10-digit US domestic string)

start_date: Date

Employee’s start date with the employer

formatdate

status: :active | :terminated

Employee status (active or terminated)

One of the following:

:active

:terminated

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { address_line_1, city, state, 2 more}

Employee’s residential address

address_line_1: String

Primary street address

city: String

City name

state: String

Two-letter state code (e.g., CA, NY)

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

employer_name: String

Name of the employer this employment is with

gender: String

Gender identity, if provided

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

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

termination_date: Date

Employee’s termination date, if terminated

formatdate