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?): EmployeeRetrieveResponse { data }

GET/v1/employees/{employee_id}

Update employee

client.employees.update(stringemployeeID, EmployeeUpdateParams { effective_date, address, compensation_type, 5 more } body, RequestOptionsoptions?): EmployeeUpdateResponse { data }

PATCH/v1/employees/{employee_id}

List employee enrollments

client.employees.listEnrollments(stringemployeeID, EmployeeListEnrollmentsParams { limit, page } query?, RequestOptionsoptions?): PageNumberPage<Enrollment { id, answered_at, benefit, 10 more } >

GET/v1/employees/{employee_id}/enrollments

ModelsExpand Collapse

Employee { id, classification_effective_date, compensation_type, 20 more }

id: string

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: string

Date the employee’s current classification took effect

formatdate

compensation_type: "Salary" | "Hourly" | null

• Salary - Salary
• Hourly - Hourly

One of the following:

"Salary"

"Hourly"

compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array<Deduction>

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

Employee deduction amount in cents

deduction_category: string | null

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

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

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 | null

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate

status: "active" | "terminated"

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address?: Address | null

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 | null

Secondary street address (apt, suite, etc.)

employer_name?: string | null

Name of the employer this employment is with

gender?: string | null

Gender identity, if provided

reference_id?: string | null

Partner-assigned reference ID for the employee

suffix?: string | null

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

termination_date?: string | null

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"

Pagination { limit, page, total, total_pages }

Pagination metadata for list responses.

limit: number

Items per page

page: number

Current page number

total: number

Total number of items

total_pages: number

Total number of pages

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

Date the employee’s current classification took effect

formatdate

compensation_type: "Salary" | "Hourly" | null

• Salary - Salary
• Hourly - Hourly

One of the following:

"Salary"

"Hourly"

compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array<Deduction>

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

Employee deduction amount in cents

deduction_category: string | null

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

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

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 | null

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate

status: "active" | "terminated"

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address?: Address | null

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 | null

Secondary street address (apt, suite, etc.)

employer_name?: string | null

Name of the employer this employment is with

gender?: string | null

Gender identity, if provided

reference_id?: string | null

Partner-assigned reference ID for the employee

suffix?: string | null

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

termination_date?: string | null

Employee’s termination date, if terminated

formatdate

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

Date the employee’s current classification took effect

formatdate

compensation_type: "Salary" | "Hourly" | null

• Salary - Salary
• Hourly - Hourly

One of the following:

"Salary"

"Hourly"

compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array<Deduction>

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

Employee deduction amount in cents

deduction_category: string | null

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

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

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 | null

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate

status: "active" | "terminated"

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address?: Address | null

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 | null

Secondary street address (apt, suite, etc.)

employer_name?: string | null

Name of the employer this employment is with

gender?: string | null

Gender identity, if provided

reference_id?: string | null

Partner-assigned reference ID for the employee

suffix?: string | null

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

termination_date?: string | null

Employee’s termination date, if terminated

formatdate