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

Employers

List employers
client.employers.list(EmployerListParams { active_in, limit, name, page } query?, RequestOptionsoptions?): EmployerListResponse { id, active, created_at, 7 more }
get/v1/employers
Create employer
client.employers.create(EmployerCreateParams { address, ein, legal_name, name } body, RequestOptionsoptions?): Employer { id, active, created_at, 7 more }
post/v1/employers
Get employer
client.employers.retrieve(stringemployerID, RequestOptionsoptions?): Employer { id, active, created_at, 7 more }
get/v1/employers/{employer_id}
Update employer
client.employers.update(stringemployerID, EmployerUpdateParams { active, address, legal_name, name } body?, RequestOptionsoptions?): Employer { id, active, created_at, 7 more }
put/v1/employers/{employer_id}
Create eligibility policy
client.employers.createEligibilityPolicy(stringemployerID, EmployerCreateEligibilityPolicyParams { effective_date, name, rules, 2 more } params, RequestOptionsoptions?): BenefitEligibilityPolicy { id, active, created_at, 7 more }
post/v1/employers/{employer_id}/benefit-eligibility-policy
ModelsExpand Collapse
Employer { id, active, created_at, 7 more }

Serializer for Employer entity in public API responses.

Matches EmployerEntity from company module domain.

id: string

Unique employer identifier with 'empr_' prefix

active: boolean

Whether the employer is currently active in the system

created_at: string

Timestamp when the employer was created

formatdate-time
name: string

Display name of the employer

organization_id: string

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time
address?: Address | null

Nested address within EmployerSerializer.

city: string

City name

state: string

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

street_1: string

Primary street address

zip_code: string

ZIP code (5 or 9 digit)

country?: string

Country code (default: US)

street_2?: string | null

Secondary street address (apt, suite, etc.)

ein?: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id?: string | null

ID of the benefit eligibility policy (epol_*), if assigned

EmployersEmployees

List employees
client.employers.employees.list(stringemployerID, EmployeeListParams { active_in, employee_class, limit, page } query?, RequestOptionsoptions?): EmployeeListResponse { id, active, created_at, 7 more }
get/v1/employers/{employer_id}/employees
Create employee
client.employers.employees.create(stringemployerID, EmployeeCreateParams { date_of_birth, email, first_name, 9 more } body, RequestOptionsoptions?): Employee { id, active, created_at, 7 more }
post/v1/employers/{employer_id}/employees
ModelsExpand Collapse
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
Accepts one of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"