List employees

employers.employees.list(employer_id, **kwargs) -> EmployeeListResponse { id, active, created_at, 7 more }

get/v1/employers/{employer_id}/employees

Retrieves a paginated list of all employees for a specific employer. Use query parameters to filter by active status or employment classification. Results are paginated using page and limit parameters.

ParametersExpand Collapse

employer_id: String

active_in: bool

Filter by active status

employee_class: EmployeeClass

Filter by employment classification

Accepts one of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

limit: Integer

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

minimum1

maximum100

page: Integer

Page number (default: 1)

minimum1

ReturnsExpand Collapse

Array[Employee { id, active, created_at, 7 more } ]

id: String

Unique employee identifier with 'empl_' prefix

active: bool

Whether the employee is currently active

created_at: Time

Timestamp when the employee was created

formatdate-time

employer_id: String

ID of the employer this employee works for (empr_*)

member: { id, date_of_birth, first_name, 6 more}

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: String

Unique member identifier with 'mbr_' prefix

date_of_birth: Date

Member's date of birth (YYYY-MM-DD)

formatdate

first_name: String

Member's legal first name

last_name: String

Member's legal last name

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

:Male

:Female

:Other

:Unknown

email: String

Email address for communications

formatemail

gender: String

Gender identity, if provided

phone: String

Phone number

suffix: String

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

start_date: Date

Employee's start/hire date with the employer

formatdate

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { city, state, street_1, 3 more}

Nested address for employee.

city: String

City name

state: String

Two-letter state code

street_1: String

Primary street address

zip_code: String

ZIP code

country: String

Country code

street_2: String

Secondary street address

employee_class: EmployeeClass

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

Accepts one of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

termination_date: Date

Employee's termination date, if terminated

formatdate

List employees

require "vitable_connect_api"

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

employees = vitable_connect_api.employers.employees.list("empr_abc123def456")

puts(employees)

[
  {
    "id": "id",
    "active": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "member": {
      "id": "id",
      "date_of_birth": "2019-12-27",
      "first_name": "first_name",
      "last_name": "last_name",
      "sex": "Male",
      "email": "dev@stainless.com",
      "gender": "gender",
      "phone": "phone",
      "suffix": "suffix"
    },
    "start_date": "2019-12-27",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "city": "city",
      "state": "state",
      "street_1": "street_1",
      "zip_code": "zip_code",
      "country": "country",
      "street_2": "street_2"
    },
    "employee_class": "Full Time",
    "termination_date": "2019-12-27"
  }
]

Returns Examples

[
  {
    "id": "id",
    "active": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "member": {
      "id": "id",
      "date_of_birth": "2019-12-27",
      "first_name": "first_name",
      "last_name": "last_name",
      "sex": "Male",
      "email": "dev@stainless.com",
      "gender": "gender",
      "phone": "phone",
      "suffix": "suffix"
    },
    "start_date": "2019-12-27",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "city": "city",
      "state": "state",
      "street_1": "street_1",
      "zip_code": "zip_code",
      "country": "country",
      "street_2": "street_2"
    },
    "employee_class": "Full Time",
    "termination_date": "2019-12-27"
  }
]