> 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 Benefit Plan Year Enrollments

GET https://api.vitablehealth.com/v1/employers/{employer_id}/benefit-plan-years/{benefit_plan_year_id}/enrollments

Returns a paginated list of every member with an enrollment in one of an employer's plan years, any election status: what they elected, where their coverage stands, dependent count, carrier, plan, tier, and the plan's total monthly cost. The caller must be authorized for the employer `empr_<...>`; an unknown or unauthorized employer, or an unknown plan year `plyr_<...>`, returns 404.

Reference: https://developer.vitablehealth.com/api/employers/list-benefit-plan-year-enrollments

## 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

- `benefit_plan_year_id` (string, required) — Unique benefit-plan-year identifier (plyr_*).
- `employer_id` (string, required) — Unique employer identifier (empr_*).

### Query parameters

- `election_status` (list of enum, optional) — Filter by election status. Repeat the parameter to match several.
  - Allowed values: `Enrolled`, `Expired`, `Pending`, `Waived`
- `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. Matches member name partially, and the `member_id` exactly — either your own reference id or the prefixed `grpmbr_<...>` id.

### 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 PlanYearEnrollment, required) — This page of plan year enrollments.
- `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

### 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

### PlanYearEnrollment

- `member_id` (string, required) — Our id for the person (`mbr_<...>`). Stable across every employer they work for.
- `employee_id` (string, required) — Our id for this person's employment with this employer (`empl_<...>`). A person who leaves and is rehired has two.
- `employee_external_reference_id` (string, required, nullable) — Your own reference id for this employee, as you supplied it. Null when you have not set one.
- `member_first_name` (string, required) — The member's first name.
- `member_last_name` (string, required) — The member's last name.
- `election_status` (enum, required) — Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open and `Expired` once it has closed. * `Enrolled` - Enrolled * `Waived` - Waived * `Pending` - Pending * `Expired` - Expired
  - Allowed values: `Enrolled`, `Waived`, `Pending`, `Expired`
- `policy_status` (enum, required, nullable) — Where the member's coverage stands: `Coverage Upcoming`, `Coverage Effective`, `Coverage Ended`, or `Cancelled`. Null unless the member enrolled. * `Coverage Upcoming` - Coverage Upcoming * `Coverage Effective` - Coverage Effective * `Coverage Ended` - Coverage Ended * `Cancelled` - Cancelled
  - Allowed values: `Coverage Upcoming`, `Coverage Effective`, `Coverage Ended`, `Cancelled`
- `dependent_count` (integer, required) — Dependents covered under this enrollment today. Counts the same dependents `premium_in_cents` is priced for, so a dependent whose termination is dated in the future still counts.
- `carrier` (string, required, nullable) — The carrier for this enrollment: the individual-market carrier for an ICHRA plan, otherwise the benefit's own. Null when the benefit has no carrier.
- `plan` (string, required, nullable) — Chosen plan name, or null when unanswered/waived.
- `tier` (string, required, nullable) — Chosen coverage tier, or null when unanswered/waived.
- `premium_in_cents` (integer, required, nullable) — Monthly premium in cents for the chosen plan, dependents included. The plan's own cost, not the employer's share of it. Null when unanswered/waived.
- `employer_contribution_in_cents` (integer, required, nullable) — The employer's monthly share of `premium_in_cents`, in cents. Null when unanswered/waived.
- `employee_deduction_in_cents` (integer, required, nullable) — What the employee is deducted monthly, in cents: `premium_in_cents` less `employer_contribution_in_cents`, floored at zero. Null when unanswered/waived.
- `plan_year_ichra_affordability` (enum, required, nullable) — Whether this ICHRA plan year was marked `Affordable` or `Not Affordable` when it was configured. A plan-year setting, not a calculation for this member. Null for non-ICHRA plan years and for ICHRA plan years where it has not been set. * `Affordable` - Affordable * `Not Affordable` - Not Affordable
  - Allowed values: `Affordable`, `Not Affordable`

### 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

## Examples

**Response**

```json
{
  "data": [
    {
      "member_id": "mbr_SGVsbG8gV29ybGQh",
      "employee_id": "empl_V2VsY29tZSB0byBBY21l",
      "employee_external_reference_id": "EXT-10023",
      "member_first_name": "Ada",
      "member_last_name": "Lovelace",
      "election_status": "Enrolled",
      "policy_status": "Coverage Effective",
      "dependent_count": 1,
      "carrier": "Vitable",
      "plan": "Vitable Dental PPO",
      "tier": "Employee Plus Spouse",
      "premium_in_cents": 12000,
      "employer_contribution_in_cents": 9000,
      "employee_deduction_in_cents": 3000,
      "plan_year_ichra_affordability": "Affordable"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 66,
    "total_pages": 4
  }
}
```

**SDK Code**

```python Plan year enrollments
import requests

url = "https://api.vitablehealth.com/v1/employers/empr_abc123def456/benefit-plan-years/plyr_abc123def456/enrollments"

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

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

print(response.json())
```

```javascript Plan year enrollments
const url = 'https://api.vitablehealth.com/v1/employers/empr_abc123def456/benefit-plan-years/plyr_abc123def456/enrollments';
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 Plan year enrollments
package main

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

func main() {

	url := "https://api.vitablehealth.com/v1/employers/empr_abc123def456/benefit-plan-years/plyr_abc123def456/enrollments"

	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 Plan year enrollments
require 'uri'
require 'net/http'

url = URI("https://api.vitablehealth.com/v1/employers/empr_abc123def456/benefit-plan-years/plyr_abc123def456/enrollments")

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 Plan year enrollments
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/benefit-plan-years/plyr_abc123def456/enrollments")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php Plan year enrollments
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Plan year enrollments
using RestSharp;

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

```swift Plan year enrollments
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vitablehealth.com/v1/employers/empr_abc123def456/benefit-plan-years/plyr_abc123def456/enrollments")! 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()
```