Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employees

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

Unique employee identifier with 'empl_' prefix

created_at: Time

Timestamp when the employee was created

formatdate-time
date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate
email: String

Email address

formatemail
enrollments: Array[{ id, status, answered_at}]

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

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: 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.)

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"
gender: String

Gender identity, if provided

hire_date: Date

Employee's hire date with the employer

formatdate
phone: String

Phone number (10-digit US domestic string)

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"