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

# List eligibility checks

> Your organization's eligibility checks, most recent first, including those run from the HealOS dashboard. Pass `patient_id` to list one patient's checks. Requires the `benefits:read` scope.



## OpenAPI

````yaml /openapi/ext-api-v1.json get /benefits/eligibility-checks
openapi: 3.0.0
info:
  title: Healos External API
  version: 1.0.0
  description: >-
    External API for managing patients, documents, and appointments, listing
    providers and note templates, pulling clinical notes (with transcript and
    patient context), and running insurance eligibility checks.
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /benefits/eligibility-checks:
    get:
      tags:
        - Benefits
      summary: List eligibility checks
      description: >-
        Your organization's eligibility checks, most recent first, including
        those run from the HealOS dashboard. Pass `patient_id` to list one
        patient's checks. Requires the `benefits:read` scope.
      parameters:
        - schema:
            type: string
            default: '1'
            example: '1'
          required: false
          name: page
          in: query
        - schema:
            type: string
            default: '20'
            example: '20'
          required: false
          name: limit
          in: query
        - schema:
            type: string
            pattern: ^\d+$
            description: Only checks run for this HealOS patient.
          required: false
          name: patient_id
          in: query
      responses:
        '200':
          description: Eligibility checks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibilityCheckListResponse'
        '400':
          description: Invalid query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    EligibilityCheckListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EligibilityCheck'
        meta:
          type: object
          properties:
            page:
              type: number
            limit:
              type: number
            total_pages:
              type: number
          required:
            - page
            - limit
            - total_pages
      required:
        - data
        - meta
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    RateLimitError:
      type: object
      properties:
        error:
          type: string
          example: Rate limit exceeded. Please retry after the window resets.
      required:
        - error
    EligibilityCheck:
      type: object
      properties:
        id:
          type: string
          example: 3f2b9c1e-6a7d-4e1f-9b0a-2c4d5e6f7a8b
        status:
          type: string
          description: Coverage status as reported by the payer (e.g. Active, Inactive).
          example: Active
        patient_name:
          type: string
          example: Jordan Rivera
        payer_name:
          type: string
          example: Aetna
        member_id:
          type: string
          example: W123456789
        patient_id:
          type: string
          nullable: true
          description: The HealOS patient, when the check was run for one.
        insurance_type:
          type: string
          enum:
            - primary
            - secondary
        linked_check_id:
          type: string
          nullable: true
        checked_at:
          type: string
          description: When the check was first run (ISO 8601).
        last_checked_at:
          type: string
          description: When the check last ran (ISO 8601).
        result:
          type: object
          nullable: true
          additionalProperties:
            nullable: true
          description: >-
            The payer's normalized eligibility response: `subscriber`, `payer`,
            `provider`, `plan` (plan names, group, coverage dates), `benefits`
            (one entry per benefit: type, coverage level, network, amount or
            percentage, time period, auth required), plus any `issues` /
            `warnings` the payer returned.
      required:
        - id
        - status
        - patient_name
        - payer_name
        - member_id
        - patient_id
        - insurance_type
        - linked_check_id
        - checked_at
        - last_checked_at
        - result
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.