Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employees

Get employee
employees.retrieve(stremployee_id) -> EmployeeRetrieveResponse
GET/v1/employees/{employee_id}
List employee enrollments
employees.list_enrollments(stremployee_id, EmployeeListEnrollmentsParams**kwargs) -> SyncPageNumberPage[Enrollment]
GET/v1/employees/{employee_id}/enrollments
ModelsExpand Collapse
class Employee: …
id: str

Unique employee identifier with 'empl_' prefix

created_at: datetime

Timestamp when the employee was created

formatdate-time
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
email: str

Email address

formatemail
enrollments: List[Enrollment]

Benefit enrollments for this employee

id: str

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: Optional[datetime]

Timestamp when the enrollment decision was made

formatdate-time
first_name: str

Employee's legal first name

last_name: str

Employee's legal last name

member_id: str

Unique member identifier with 'mbr_' prefix

status: str

Employee status (active or terminated)

updated_at: datetime

Timestamp when the employee was last updated

formatdate-time
address: Optional[Address]

Employee's residential address

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employee_class: Optional[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: Optional[str]

Gender identity, if provided

hire_date: Optional[date]

Employee's hire date with the employer

formatdate
phone: Optional[str]

Phone number (10-digit US domestic string)

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

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

termination_date: Optional[date]

Employee's termination date, if terminated

formatdate
Literal["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"