Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Employers
Employees

List employees

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.

Path ParametersExpand Collapse
employer_id: string
Query ParametersExpand Collapse
active_in: optional boolean

Filter by active status

employee_class: optional EmployeeClass

Filter by employment classification

Accepts one of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
limit: optional number

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

minimum1
maximum100
page: optional number

Page number (default: 1)

minimum1
ReturnsExpand Collapse
id: string

Unique employee identifier with 'empl_' prefix

active: boolean

Whether the employee is currently active

created_at: string

Timestamp when the employee was created

formatdate-time
employer_id: string

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

member: object { 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: string

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: optional string

Email address for communications

formatemail
gender: optional string

Gender identity, if provided

phone: optional string

Phone number

suffix: optional string

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

start_date: string

Employee's start/hire date with the employer

formatdate
updated_at: string

Timestamp when the employee was last updated

formatdate-time
address: optional object { 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: optional string

Country code

street_2: optional string

Secondary street address

employee_class: optional 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: optional string

Employee's termination date, if terminated

formatdate
List employees
curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/employees \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY"
[
  {
    "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"
  }
]