API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Employers

List employers

employers.list(EmployerListParams**kwargs) -> EmployerListResponse

get/v1/employers

Create employer

employers.create(EmployerCreateParams**kwargs) -> Employer

post/v1/employers

Get employer

employers.retrieve(stremployer_id) -> Employer

get/v1/employers/{employer_id}

Update employer

employers.update(stremployer_id, EmployerUpdateParams**kwargs) -> Employer

put/v1/employers/{employer_id}

Create eligibility policy

employers.create_eligibility_policy(stremployer_id, EmployerCreateEligibilityPolicyParams**kwargs) -> BenefitEligibilityPolicy

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

ModelsExpand Collapse

class Employer: …

Serializer for Employer entity in public API responses.

Matches EmployerEntity from company module domain.

id: str

Unique employer identifier with 'empr_' prefix

active: bool

Whether the employer is currently active in the system

created_at: datetime

Timestamp when the employer was created

formatdate-time

legal_name: str

Legal business name for compliance and tax purposes

name: str

Display name of the employer

organization_id: str

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time

address: Optional[Address]

Nested address within EmployerSerializer.

city: str

City name

state: str

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

street_1: str

Primary street address

zip_code: str

ZIP code (5 or 9 digit)

country: Optional[str]

Country code (default: US)

street_2: Optional[str]

Secondary street address (apt, suite, etc.)

ein: Optional[str]

Employer Identification Number (masked in responses)

eligibility_policy_id: Optional[str]

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

EmployersEmployees

List employees

employers.employees.list(stremployer_id, EmployeeListParams**kwargs) -> EmployeeListResponse

get/v1/employers/{employer_id}/employees

Create employee

employers.employees.create(stremployer_id, EmployeeCreateParams**kwargs) -> Employee

post/v1/employers/{employer_id}/employees

ModelsExpand Collapse

EmployeeClass = Literal["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"