Employers

List employers

get/v1/employers

Create employer

post/v1/employers

Get employer

get/v1/employers/{employer_id}

Update employer

put/v1/employers/{employer_id}

Create eligibility policy

post/v1/employers/{employer_id}/benefit-eligibility-policy

ModelsExpand Collapse

Employer = object { 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

legal_name: string

Legal business name for compliance and tax purposes

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: optional object { city, state, street_1, 3 more }

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: optional string

Country code (default: US)

street_2: optional string

Secondary street address (apt, suite, etc.)

ein: optional string

Employer Identification Number (masked in responses)

eligibility_policy_id: optional string

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

EmployersEmployees

List employees

get/v1/employers/{employer_id}/employees

Create employee

post/v1/employers/{employer_id}/employees

ModelsExpand Collapse

EmployeeClass = "Full Time" or "Part Time" or "Temporary" or 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"