Get employer

client.employers.retrieve(, ?): EmployerResponse { data }

GET/v1/employers/{employer_id}

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

ParametersExpand Collapse

employerID: string

Unique employer identifier (empr_*)

ReturnsExpand Collapse

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

Whether the employer is currently active in the system

address: 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 | null

Secondary street address (apt, suite, etc.)

created_at: string

Timestamp when the employer was created

formatdate-time

ein: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id: string | null

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 | null

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time

email?: string | null

Email address for billing and communications

formatemail

phone_number?: string | null

Employer phone number (E.164 format recommended)

reference_id?: string | null

Partner-assigned reference ID for the employer

Get employer

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const employerResponse = await client.employers.retrieve('empr_abc123def456');

console.log(employerResponse.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"
  }
}