Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference

Employees

Get employee
get/v1/employees/{employee_id}
Update employee
put/v1/employees/{employee_id}
Terminate employee
delete/v1/employees/{employee_id}
ModelsExpand Collapse
Employee = object { id, active, created_at, 7 more }

Serializer for Employee entity in public API responses.

Note: Employee is in the company module but exposed via account public API. Contains nested MemberEntity with personal identity information.

id: string

Unique employee identifier with 'empl_' prefix

active: boolean

Whether the employee is currently active

created_at: string

Timestamp when the employee was created

formatdate-time
employer_id: string

ID of the employer this employee works for (empr_*)

member: object { id, date_of_birth, first_name, 6 more }

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: string

Unique member identifier with 'mbr_' prefix

date_of_birth: string

Member's date of birth (YYYY-MM-DD)

formatdate
first_name: string

Member's legal first name

last_name: string

Member's legal last name

sex: Sex
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
Accepts one of the following:
"Male"
"Female"
"Other"
"Unknown"
email: optional string

Email address for communications

formatemail
gender: optional string

Gender identity, if provided

phone: optional string

Phone number

suffix: optional string

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

start_date: string

Employee's start/hire date with the employer

formatdate
updated_at: string

Timestamp when the employee was last updated

formatdate-time
address: optional object { city, state, street_1, 3 more }

Nested address for employee.

city: string

City name

state: string

Two-letter state code

street_1: string

Primary street address

zip_code: string

ZIP code

country: optional string

Country code

street_2: optional string

Secondary street address

employee_class: optional EmployeeClass
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
Accepts one of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
termination_date: optional string

Employee's termination date, if terminated

formatdate

EmployeesEnrollments

List employee enrollments
get/v1/employees/{employee_id}/enrollments
Submit benefit elections
post/v1/employees/{employee_id}/enrollments/elect
ModelsExpand Collapse
EnrollmentStatus = "pending" or "enrolled" or "waived" or "inactive"
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
Accepts one of the following:
"pending"
"enrolled"
"waived"
"inactive"