Skip to main content
GET
/
v1
/
company-benefits
/
{company_benefit_id}
/
enrollments
List enrollments for a specific benefit plan
curl --request GET \
  --url https://api.vitablehealth.com/v1/company-benefits/{company_benefit_id}/enrollments \
  --header 'X-Partner-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enrollment_status": "Unanswered",
      "plan_name": "<string>",
      "tier_name": "<string>",
      "employee_premium": 123,
      "employer_contribution": 123,
      "coverage_start_date": "2023-12-25",
      "coverage_end_date": "2023-12-25",
      "enrollment_date": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

company_benefit_id
string<uuid>
required

Unique identifier for the benefit plan

Query Parameters

limit
integer
default:20

Number of results to return per page

page
integer
default:1

Page number for pagination

Response

200 - application/json

List of enrollments for the benefit plan

data
object[]
pagination
object