Employers

List employers

employers.list(**kwargs) -> PageNumberPage<Employer { id, active, address, 10 more } >

GET/v1/employers

Create employer

employers.create(**kwargs) -> EmployerResponse { data }

POST/v1/employers

Get employer

employers.retrieve(employer_id) -> EmployerResponse { data }

GET/v1/employers/{employer_id}

Create eligibility policy

employers.create_benefit_eligibility_policy(employer_id, **kwargs) -> BenefitEligibilityPolicyResponse { data }

POST/v1/employers/{employer_id}/benefit-eligibility-policies

Submit census sync

employers.submit_census_sync(employer_id, **kwargs) -> EmployerSubmitCensusSyncResponse { data }

POST/v1/employers/{employer_id}/census-sync

List employees

employers.list_employees(employer_id, **kwargs) -> PageNumberPage<Employee { id, created_at, date_of_birth, 15 more } >

GET/v1/employers/{employer_id}/employees

ModelsExpand Collapse

class Employer { id, active, address, 10 more }

Serializer for Employer entity in public API responses.

id: String

Unique employer identifier with 'empr_' prefix

active: bool

Whether the employer is currently active in the system

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

Secondary street address (apt, suite, etc.)

created_at: Time

Timestamp when the employer was created

formatdate-time

ein: String

Employer Identification Number (masked in responses)

eligibility_policy_id: String

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

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

email: String

Email address for billing and communications

formatemail

phone_number: String

Employer phone number (E.164 format recommended)

reference_id: String

Partner-assigned reference ID for the employer

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

Whether the employer is currently active in the system

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

Secondary street address (apt, suite, etc.)

created_at: Time

Timestamp when the employer was created

formatdate-time

ein: String

Employer Identification Number (masked in responses)

eligibility_policy_id: String

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

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

email: String

Email address for billing and communications

formatemail

phone_number: String

Employer phone number (E.164 format recommended)

reference_id: String

Partner-assigned reference ID for the employer