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

Get employer

employers.retrieve(employer_id) -> 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
employer_id: String

Unique employer identifier (empr_*)

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

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

Get employer

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

employer_response = vitable_connect.employers.retrieve("empr_abc123def456")

puts(employer_response)
{
  "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"
  }
}