List employees

employers.list_employees(employer_id, **kwargs) -> PageNumberPage<Employee { id, created_at, date_of_birth, 15 more } >

GET/v1/employers/{employer_id}/employees

Retrieves a paginated list of all employees for a specific employer. Results are paginated using page and limit parameters.

ParametersExpand Collapse

employer_id: String

Unique employer identifier (empr_*)

limit: Integer

Items per page (default: 20, max: 100)

minimum1

maximum100

page: Integer

Page number (default: 1)

minimum1

ReturnsExpand Collapse

class Employee { id, created_at, date_of_birth, 15 more }

id: String

Unique employee identifier with 'empl_' prefix

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

email: String

Email address

formatemail

enrollments: Array[{ id, status, answered_at}]

Benefit enrollments for this employee

id: String

Unique enrollment identifier with 'enrl_' prefix

status: EnrollmentStatus

pending - Pending
enrolled - Enrolled
waived - Waived
inactive - Inactive

One of the following:

:pending

:enrolled

:waived

:inactive

answered_at: Time

Timestamp when the enrollment decision was made

formatdate-time

first_name: String

Employee's legal first name

last_name: String

Employee's legal last name

member_id: String

Unique member identifier with 'mbr_' prefix

status: String

Employee status (active or terminated)

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { address_line_1, city, state, 2 more}

Employee's residential address

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.)

employee_class: EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

gender: String

Gender identity, if provided

hire_date: Date

Employee's hire date with the employer

formatdate

phone: String

Phone number (10-digit US domestic string)

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

Name suffix (e.g., Jr., Sr., III)

termination_date: Date

Employee's termination date, if terminated

formatdate

List employees

require "vitable_connect"

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

page = vitable_connect.employers.list_employees("empr_abc123def456")

puts(page)

{
  "data": [
    {
      "id": "empl_abc123",
      "member_id": "mbr_xyz789",
      "reference_id": "partner-ee-001",
      "first_name": "John",
      "last_name": "Doe",
      "suffix": null,
      "email": "john.doe@example.com",
      "date_of_birth": "1985-06-15",
      "gender": null,
      "phone": "4155551234",
      "employee_class": "Full Time",
      "status": "active",
      "hire_date": "2023-01-15",
      "termination_date": null,
      "address": {
        "address_line_1": "456 Oak Avenue",
        "address_line_2": "Apt 2B",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94102"
      },
      "enrollments": [
        {
          "id": "enrl_abc123",
          "status": "enrolled",
          "answered_at": "2023-01-20T10:00:00Z"
        }
      ],
      "created_at": "2023-01-15T09:00:00Z",
      "updated_at": "2024-06-01T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}

Returns Examples

{
  "data": [
    {
      "id": "empl_abc123",
      "member_id": "mbr_xyz789",
      "reference_id": "partner-ee-001",
      "first_name": "John",
      "last_name": "Doe",
      "suffix": null,
      "email": "john.doe@example.com",
      "date_of_birth": "1985-06-15",
      "gender": null,
      "phone": "4155551234",
      "employee_class": "Full Time",
      "status": "active",
      "hire_date": "2023-01-15",
      "termination_date": null,
      "address": {
        "address_line_1": "456 Oak Avenue",
        "address_line_2": "Apt 2B",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94102"
      },
      "enrollments": [
        {
          "id": "enrl_abc123",
          "status": "enrolled",
          "answered_at": "2023-01-20T10:00:00Z"
        }
      ],
      "created_at": "2023-01-15T09:00:00Z",
      "updated_at": "2024-06-01T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}