> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.vitablehealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.vitablehealth.com/_mcp/server.

# List Employees

GET https://api.vitablehealth.com/v1/employers/{employer_id}/employees

Retrieves a paginated list of employees for a specific employer. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404. Results are paginated using page and limit parameters and can be narrowed with a case-insensitive `search` (first name, last name, or email) and an `employment_status` filter (active or terminated). Each employee includes payroll deductions from the most recent statement period. When a new deduction statement is generated, previous period deductions are replaced.

Reference: https://developer.vitablehealth.com/api/employers/list-employees

## Authentication

- `Authorization` header (bearer token, required) — API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

## Servers

- `https://api.vitablehealth.com` (Production, default)
- `https://api.uat.vitablehealth.com` (UAT)

## Request

### Path parameters

- `employer_id` (string, required) — Unique employer identifier (empr_*)

### Query parameters

- `employment_status` (enum, optional) — Filter by employment status (active or terminated)
  - Allowed values: `active`, `terminated`
- `limit` (integer, optional, default: 20) — Items per page (default: 20, max: 100)
- `page` (integer, optional, default: 1) — Page number (default: 1)
- `search` (string, optional) — Case-insensitive search across employee first name, last name, and email

### Headers

- `X-Vitable-Organization` (string, optional) — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.

## Response

### 200

- `data` (list of Employee, required) — This page of employees.
- `pagination` (Pagination, required) — Page metadata. Request the next page by incrementing `page`.

## Errors

### 400 Bad Request Error

Bad Request - Invalid input or validation error

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 401 Unauthorized Error

Unauthorized - Invalid or missing API key

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 403 Forbidden Error

Forbidden - Insufficient permissions for this resource

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 404 Not Found Error

Resource not found.

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 409 Conflict Error

Conflict - Resource already exists or conflicts with current state

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 422 Unprocessable Entity Error

Unprocessable Entity - Business rule or domain invariant violated

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 429 Too Many Requests Error

Too Many Requests - Rate limit exceeded

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 500 Internal Server Error

Internal Server Error - An unexpected error occurred

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 502 Bad Gateway Error

Bad Gateway - External service error

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

## Types

### Employee

- `id` (string, required) — Unique employee identifier with 'empl_' prefix
- `member_id` (string, required) — Unique member identifier with 'mbr_' prefix
- `employer_id` (string, required) — Unique identifier of the employer this employment is with (empr_*)
- `first_name` (string, required) — Employee's legal first name
- `last_name` (string, required) — Employee's legal last name
- `email` (string, required) — Email address
- `date_of_birth` (date, required) — Date of birth (YYYY-MM-DD)
- `phone` (string, required, nullable) — Phone number (10-digit US domestic string)
- `employee_class` (enum, required) — Employment classification affecting benefit eligibility * `Full Time` - Full Time * `Part Time` - Part Time * `Temporary` - Temporary * `Intern` - Intern * `Seasonal` - Seasonal * `Individual Contractor` - Individual Contractor
  - Allowed values: `Full Time`, `Part Time`, `Temporary`, `Intern`, `Seasonal`, `Individual Contractor`
- `status` (enum, required) — Employee status (active or terminated)
  - Allowed values: `active`, `terminated`
- `start_date` (date, required) — Employee's start date with the employer
- `classification_effective_date` (date, required) — Date the employee's current classification took effect
- `compensation_type` (enum, required, nullable) — Employee's compensation type
  - Allowed values: `Salary`, `Hourly`
- `compensation_type_effective_date` (date, required) — Date the employee's current compensation type took effect
- `deductions` (list of DeductionDetail, required) — Payroll deductions from the most recent statement period. Replaced when a new statement is generated.
- `created_at` (datetime, required) — Timestamp when the employee was created
- `updated_at` (datetime, required) — Timestamp when the employee was last updated
- `reference_id` (string, optional, nullable) — Partner-assigned reference ID for the employee
- `employer_name` (string, optional, nullable) — Name of the employer this employment is with
- `suffix` (string, optional, nullable) — Name suffix (e.g., Jr., Sr., III)
- `gender` (string, optional, nullable) — Gender identity, if provided
- `termination_date` (date, optional, nullable) — Employee's termination date, if terminated
- `address` (EmployeeAddress, optional, nullable) — Employee's residential address

### Pagination

Pagination metadata for list responses.

- `page` (integer, required) — Current page number
- `limit` (integer, required) — Items per page
- `total` (integer, required) — Total number of items
- `total_pages` (integer, required) — Total number of pages

### DeductionDetail

- `deduction_category` (string, required, nullable) — Deduction category (reserved for future use)
- `deduction_amount_in_cents` (integer, required) — Employee deduction amount in cents
- `tax_classification` (enum, required) — Tax classification: Pre-tax, Post-tax, or Unknown * `Unknown` - Unknown * `Pre-tax` - Pre Tax * `Post-tax` - Post Tax
  - Allowed values: `Unknown`, `Pre-tax`, `Post-tax`
- `frequency` (enum, required) — Deduction frequency * `weekly` - Weekly * `bi_weekly` - Bi Weekly * `semi_monthly` - Semi Monthly * `monthly` - Monthly
  - Allowed values: `weekly`, `bi_weekly`, `semi_monthly`, `monthly`
- `benefit_name` (string, required) — Name of the benefit plan
- `period_start_date` (date, required) — Period start date (YYYY-MM-DD)
- `period_end_date` (date, required) — Period end date (YYYY-MM-DD)

### EmployeeAddress

- `address_line_1` (string, required) — Primary street address
- `city` (string, required) — City name
- `state` (string, required) — Two-letter state code (e.g., CA, NY)
- `zipcode` (string, required) — ZIP code (5 or 9 digit)
- `address_line_2` (string, optional, nullable) — Secondary street address (apt, suite, etc.)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "empl_abc123",
      "member_id": "mbr_xyz789",
      "employer_id": "string",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "date_of_birth": "1985-06-15",
      "phone": "4155551234",
      "employee_class": "Full Time",
      "status": "active",
      "start_date": "2023-01-15",
      "classification_effective_date": "2023-03-01",
      "compensation_type": "Salary",
      "compensation_type_effective_date": "2023-03-01",
      "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",
      "reference_id": "partner-ee-001",
      "suffix": null,
      "gender": null,
      "termination_date": null,
      "address": {
        "address_line_1": "456 Oak Avenue",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94102",
        "address_line_2": "Apt 2B"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}
```

**SDK Code**

```python Employees List
import requests

url = "https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Employees List
const url = 'https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Employees List
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Employees List
require 'uri'
require 'net/http'

url = URI("https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java Employees List
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php Employees List
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Employees List
using RestSharp;

var client = new RestClient("https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Employees List
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vitablehealth.com/v1/employers/empr_abc123def456/employees")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```