Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Employers

Get employer

employers.retrieve(stremployer_id) -> EmployerResponse
GET/v1/employers/{employer_id}

Retrieves detailed information for a specific employer by ID. The employer must belong to the authenticated organization.

ParametersExpand Collapse
employer_id: str

Unique employer identifier (empr_*)

ReturnsExpand Collapse
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)

eligibility_policy_id: Optional[str]

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

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

Get employer

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
employer_response = client.employers.retrieve(
    "empr_abc123def456",
)
print(employer_response.data)
{
  "data": {
    "id": "empr_abc123def456",
    "organization_id": "org_xyz789",
    "name": "Acme Corporation",
    "legal_name": "Acme Corporation Inc.",
    "ein": "XX-XXX1234",
    "reference_id": "partner-emp-001",
    "email": "hr@acme.com",
    "phone_number": "4155550100",
    "active": true,
    "address": {
      "address_line_1": "123 Main Street",
      "address_line_2": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94102"
    },
    "eligibility_policy_id": "epol_policy123",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  }
}
Returns Examples
{
  "data": {
    "id": "empr_abc123def456",
    "organization_id": "org_xyz789",
    "name": "Acme Corporation",
    "legal_name": "Acme Corporation Inc.",
    "ein": "XX-XXX1234",
    "reference_id": "partner-emp-001",
    "email": "hr@acme.com",
    "phone_number": "4155550100",
    "active": true,
    "address": {
      "address_line_1": "123 Main Street",
      "address_line_2": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94102"
    },
    "eligibility_policy_id": "epol_policy123",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  }
}