Employers

List employers

employers.list(**kwargs) -> EmployerListResponse { id, active, created_at, 7 more }

get/v1/employers

Create employer

employers.create(**kwargs) -> Employer { id, active, created_at, 7 more }

post/v1/employers

Get employer

employers.retrieve(employer_id) -> Employer { id, active, created_at, 7 more }

get/v1/employers/{employer_id}

Update employer

employers.update(employer_id, **kwargs) -> Employer { id, active, created_at, 7 more }

put/v1/employers/{employer_id}

Create eligibility policy

employers.create_eligibility_policy(employer_id, **kwargs) -> BenefitEligibilityPolicyAPI { id, active, created_at, 7 more }

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

ModelsExpand Collapse

class 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: bool

Whether the employer is currently active in the system

created_at: Time

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: Time

Timestamp when the employer was last updated

formatdate-time

address: { 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: String

Country code (default: US)

street_2: String

Secondary street address (apt, suite, etc.)

ein: String

Employer Identification Number (masked in responses)

eligibility_policy_id: String

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

EmployersEmployees

List employees

employers.employees.list(employer_id, **kwargs) -> EmployeeListResponse { id, active, created_at, 7 more }

get/v1/employers/{employer_id}/employees

Create employee

employers.employees.create(employer_id, **kwargs) -> 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"