List employees

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. Each employee includes payroll deductions from the most recent statement period. When a new deduction statement is generated, previous period deductions are replaced.

Path ParametersExpand Collapse

employer_id: string

Unique employer identifier (empr_*)

Query ParametersExpand Collapse

limit: optional number

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

minimum1

maximum100

page: optional number

Page number (default: 1)

minimum1

ReturnsExpand Collapse

data: array of Employee { id, created_at, date_of_birth, 15 more }

id: string

Unique employee identifier with ‘empl_’ prefix

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: array of { benefit_name, deduction_amount_in_cents, deduction_category, 4 more }

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: string

Name of the benefit plan

deduction_amount_in_cents: number

Employee deduction amount in cents

deduction_category: string

Deduction category (reserved for future use)

frequency: "weekly" or "bi_weekly" or "semi_monthly" or "monthly"

weekly - Weekly
bi_weekly - Bi Weekly
semi_monthly - Semi Monthly
monthly - Monthly

One of the following:

"weekly"

"bi_weekly"

"semi_monthly"

"monthly"

period_end_date: string

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

Period start date (YYYY-MM-DD)

formatdate

tax_classification: "Unknown" or "Pre-tax" or "Post-tax"

Unknown - Unknown
Pre-tax - Pre Tax
Post-tax - Post Tax

One of the following:

"Unknown"

"Pre-tax"

"Post-tax"

email: string

Email address

formatemail

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

Timestamp when the employee was last updated

formatdate-time

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

Secondary street address (apt, suite, etc.)

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

Gender identity, if provided

hire_date: optional string

Employee’s hire date with the employer

formatdate

phone: optional string

Phone number (10-digit US domestic string)

reference_id: optional string

Partner-assigned reference ID for the employee

suffix: optional string

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

termination_date: optional string

Employee’s termination date, if terminated

formatdate

pagination: Pagination { limit, page, total, total_pages }

Pagination metadata for list responses.

limit: number

Items per page

page: number

Current page number

total: number

Total number of items

total_pages: number

Total number of pages

List employees

curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/employees \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"

{
  "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"
      },
      "deductions": [
        {
          "deduction_category": null,
          "deduction_amount_in_cents": 5000,
          "tax_classification": "Pre-tax",
          "frequency": "monthly",
          "benefit_name": "Gold PPO Plan",
          "period_start_date": "2025-01-01",
          "period_end_date": "2025-01-31"
        }
      ],
      "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"
      },
      "deductions": [
        {
          "deduction_category": null,
          "deduction_amount_in_cents": 5000,
          "tax_classification": "Pre-tax",
          "frequency": "monthly",
          "benefit_name": "Gold PPO Plan",
          "period_start_date": "2025-01-01",
          "period_end_date": "2025-01-31"
        }
      ],
      "created_at": "2023-01-15T09:00:00Z",
      "updated_at": "2024-06-01T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}