Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employers

List employers
employers.list(EmployerListParams**kwargs) -> SyncPageNumberPage[Employer]
GET/v1/employers
Create employer
employers.create(EmployerCreateParams**kwargs) -> EmployerResponse
POST/v1/employers
Get employer
employers.retrieve(stremployer_id) -> EmployerResponse
GET/v1/employers/{employer_id}
Submit census sync
employers.submit_census_sync(stremployer_id, EmployerSubmitCensusSyncParams**kwargs) -> EmployerSubmitCensusSyncResponse
POST/v1/employers/{employer_id}/census-sync
List employees
employers.list_employees(stremployer_id, EmployerListEmployeesParams**kwargs) -> SyncPageNumberPage[Employee]
GET/v1/employers/{employer_id}/employees
Update employer settings
employers.update_settings(stremployer_id, EmployerUpdateSettingsParams**kwargs) -> EmployerUpdateSettingsResponse
PUT/v1/employers/{employer_id}/settings
ModelsExpand Collapse
class Employer: …

Serializer for Employer entity in public API responses.

id: str

Unique employer identifier with ‘empr_’ prefix

active: bool

Whether the employer is currently active in the system

address: Address

Nested address within EmployerSerializer.

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

created_at: datetime

Timestamp when the employer was created

formatdate-time
ein: Optional[str]

Employer Identification Number (masked in responses)

name: str

Display name of the employer

organization_id: Optional[str]

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time
email: Optional[str]

Email address for billing and communications

formatemail
phone_number: Optional[str]

Employer phone number (E.164 format recommended)

reference_id: Optional[str]

Partner-assigned reference ID for the employer

class EmployerResponse: …

Response containing a single employer resource.

data: Employer

Serializer for Employer entity in public API responses.

id: str

Unique employer identifier with ‘empr_’ prefix

active: bool

Whether the employer is currently active in the system

address: Address

Nested address within EmployerSerializer.

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

created_at: datetime

Timestamp when the employer was created

formatdate-time
ein: Optional[str]

Employer Identification Number (masked in responses)

name: str

Display name of the employer

organization_id: Optional[str]

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time
email: Optional[str]

Email address for billing and communications

formatemail
phone_number: Optional[str]

Employer phone number (E.164 format recommended)

reference_id: Optional[str]

Partner-assigned reference ID for the employer

class EmployerSubmitCensusSyncResponse: …

Response containing a single census sync detail resource.

data: Data
accepted_at: datetime
formatdate-time
employer_id: str
class EmployerUpdateSettingsResponse: …

Response containing a single employer settings resource.

data: Data
pay_frequency: Optional[Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]]
  • weekly - Weekly
  • bi_weekly - Bi-Weekly
  • semi_monthly - Semi-Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"