Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employees

Get employee
client.employees.retrieve(stringemployeeID, RequestOptionsoptions?): EmployeeRetrieveResponse { data }
GET/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, created_at, date_of_birth, 15 more }
id: string

Unique employee identifier with 'empl_' prefix

created_at: string

Timestamp when the employee was created

formatdate-time
date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate
email: string

Email address

formatemail
enrollments: Array<Enrollment>

Benefit enrollments for this employee

id: string

Unique enrollment identifier with 'enrl_' prefix

status: EnrollmentStatus
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
"pending"
"enrolled"
"waived"
"inactive"
answered_at?: string | null

Timestamp when the enrollment decision was made

formatdate-time
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

status: string

Employee status (active or 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.)

employee_class?: EmployeeClass | null
  • 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"
gender?: string | null

Gender identity, if provided

hire_date?: string | null

Employee's hire date with the employer

formatdate
phone?: string | null

Phone number (10-digit US domestic string)

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"