Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employers

List employers
client.employers.list(EmployerListParams { limit, page } query?, RequestOptionsoptions?): PageNumberPage<Employer { id, active, address, 10 more } >
GET/v1/employers
Create employer
client.employers.create(EmployerCreateParams { address, ein, email, 4 more } body, RequestOptionsoptions?): EmployerResponse { data }
POST/v1/employers
Get employer
client.employers.retrieve(stringemployerID, RequestOptionsoptions?): EmployerResponse { data }
GET/v1/employers/{employer_id}
Create eligibility policy
client.employers.createBenefitEligibilityPolicy(stringemployerID, EmployerCreateBenefitEligibilityPolicyParams { classification, waiting_period } body, RequestOptionsoptions?): BenefitEligibilityPolicyResponse { data }
POST/v1/employers/{employer_id}/benefit-eligibility-policies
Submit census sync
client.employers.submitCensusSync(stringemployerID, EmployerSubmitCensusSyncParams { employees } body, RequestOptionsoptions?): EmployerSubmitCensusSyncResponse { data }
POST/v1/employers/{employer_id}/census-sync
List employees
client.employers.listEmployees(stringemployerID, EmployerListEmployeesParams { limit, page } query?, RequestOptionsoptions?): PageNumberPage<Employee { id, created_at, date_of_birth, 15 more } >
GET/v1/employers/{employer_id}/employees
ModelsExpand Collapse
Employer { id, active, address, 10 more }

Serializer for Employer entity in public API responses.

id: string

Unique employer identifier with 'empr_' prefix

active: boolean

Whether the employer is currently active in the system

address: Address { address_line_1, city, state, 2 more }

Nested address within EmployerSerializer.

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

created_at: string

Timestamp when the employer was created

formatdate-time
ein: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id: string | null

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

name: string

Display name of the employer

organization_id: string | null

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time
email?: string | null

Email address for billing and communications

formatemail
phone_number?: string | null

Employer phone number (E.164 format recommended)

reference_id?: string | null

Partner-assigned reference ID for the employer

EmployerResponse { data }

Response containing a single employer resource.

data: Employer { id, active, address, 10 more }

Serializer for Employer entity in public API responses.

id: string

Unique employer identifier with 'empr_' prefix

active: boolean

Whether the employer is currently active in the system

address: Address { address_line_1, city, state, 2 more }

Nested address within EmployerSerializer.

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

created_at: string

Timestamp when the employer was created

formatdate-time
ein: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id: string | null

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

name: string

Display name of the employer

organization_id: string | null

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time
email?: string | null

Email address for billing and communications

formatemail
phone_number?: string | null

Employer phone number (E.164 format recommended)

reference_id?: string | null

Partner-assigned reference ID for the employer