> ## 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 employee benefit eligibilities

> Retrieve benefit eligibility information for employees.
Helps payroll providers understand who is eligible for which benefits.




## OpenAPI

````yaml external-api-schema.yml get /v1/companies/{company_id}/benefit-eligibilities
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/companies/{company_id}/benefit-eligibilities:
    get:
      tags:
        - Benefit Eligibility
      summary: List employee benefit eligibilities
      description: |
        Retrieve benefit eligibility information for employees.
        Helps payroll providers understand who is eligible for which benefits.
      operationId: list_employee_benefit_eligibilities
      parameters:
        - in: path
          name: company_id
          schema:
            type: string
            format: uuid
          required: true
          description: Unique identifier for the company
        - in: query
          name: employee_name
          schema:
            type: string
          description: Filter by employee name
        - in: query
          name: terminated_in
          schema:
            type: boolean
          description: Include terminated employees
        - 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 employee benefit eligibilities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeeBenefitEligibilitiesResponse'
      security:
        - partnerApiKey: []
components:
  schemas:
    ListEmployeeBenefitEligibilitiesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeBenefitEligibility'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    EmployeeBenefitEligibility:
      type: object
      properties:
        employee_id:
          type: string
          format: uuid
          description: Employee identifier
        employee_name:
          type: string
          description: Employee full name
        benefit_eligibilities:
          type: array
          items:
            $ref: '#/components/schemas/BenefitEligibility'
    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
    BenefitEligibility:
      type: object
      properties:
        benefit_name:
          type: string
          description: Name of the benefit
        benefit_code:
          type: string
          description: Benefit type code
        eligible:
          type: boolean
          description: Whether employee is eligible
        eligibility_date:
          type: string
          format: date
          description: Date eligibility becomes effective
        waiting_period_days:
          type: integer
          description: Waiting period in days
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````