> ## Documentation Index
> Fetch the complete documentation index at: https://beta-docs.vitablehealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List enrollments for a specific benefit plan

> Get all enrollments for a particular benefit plan year.
Useful for generating enrollment reports and understanding participation rates.




## OpenAPI

````yaml external-api-schema.yml get /v1/company-benefits/{company_benefit_id}/enrollments
openapi: 3.0.3
info:
  title: Vitable External Partner API
  version: 1.0.0
  description: >
    External API for Payroll Providers and PEO platforms to integrate with
    Vitable health plan products 

    for benefit administration. This API enables partner systems to manage
    benefit enrollment, 

    employee data, and plan information for their clients.


    Common integration scenarios:

    - Retrieve active benefit plans for employers

    - List enrolled employees for benefit periods  

    - Create and update employee records

    - Manage benefit enrollments and elections

    - Access enrollment status and eligibility information
servers:
  - url: https://api.vitablehealth.com
    description: Production server
  - url: https://api-staging.vitablehealth.com
    description: Staging server
security:
  - partnerApiKey: []
tags:
  - name: Company Benefits
    description: Benefit plans available to companies (plan years)
  - name: Company Members
    description: Employee management and information
  - name: Benefit Enrollments
    description: Employee benefit enrollment status and management
  - name: Member Benefits
    description: Individual employee benefit information
  - name: Benefit Eligibility
    description: Employee benefit eligibility information
  - name: Payroll Integration
    description: Payroll deduction and contribution calculations
  - name: Quoting
    description: Marketplace plan searches and insurance quotes
paths:
  /v1/company-benefits/{company_benefit_id}/enrollments:
    get:
      tags:
        - Benefit Enrollments
      summary: List enrollments for a specific benefit plan
      description: >
        Get all enrollments for a particular benefit plan year.

        Useful for generating enrollment reports and understanding participation
        rates.
      operationId: list_company_benefit_enrollments
      parameters:
        - in: path
          name: company_benefit_id
          schema:
            type: string
            format: uuid
          required: true
          description: Unique identifier for the benefit plan
        - in: query
          name: limit
          schema:
            type: integer
            default: 20
          description: Number of results to return per page
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number for pagination
      responses:
        '200':
          description: List of enrollments for the benefit plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCompanyBenefitEnrollmentsResponse'
      security:
        - partnerApiKey: []
components:
  schemas:
    ListCompanyBenefitEnrollmentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BenefitEnrollment'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    BenefitEnrollment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique enrollment identifier
        company_benefit_id:
          type: string
          format: uuid
          description: Associated benefit plan ID
        company_member_id:
          type: string
          format: uuid
          description: Associated employee ID
        enrollment_status:
          type: string
          enum:
            - Unanswered
            - Enrolled
            - Waived
          description: Current enrollment status
        plan_name:
          type: string
          description: Selected benefit plan name
        tier_name:
          type: string
          description: Selected coverage tier
        employee_premium:
          type: integer
          description: Employee premium amount in cents
        employer_contribution:
          type: integer
          description: Employer contribution in cents
        coverage_start_date:
          type: string
          format: date
          description: Coverage effective date
        coverage_end_date:
          type: string
          format: date
          description: Coverage termination date
        enrollment_date:
          type: string
          format: date-time
          description: Date enrollment was completed
    PaginationInfo:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        limit:
          type: integer
          description: Number of items per page
        total_count:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````