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

# Search payers

> Find the `payer_id` to use on an eligibility check. Matches payer names and ids; queries shorter than 2 characters return an empty list. Requires the `benefits:read` scope.



## OpenAPI

````yaml /openapi/ext-api-v1.json get /benefits/payers/search
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/payers/search:
    get:
      tags:
        - Benefits
      summary: Search payers
      description: >-
        Find the `payer_id` to use on an eligibility check. Matches payer names
        and ids; queries shorter than 2 characters return an empty list.
        Requires the `benefits:read` scope.
      parameters:
        - schema:
            type: string
            description: >-
              Payer name or id; at least 2 characters (shorter queries return no
              results).
            example: aetna
          required: true
          name: q
          in: query
      responses:
        '200':
          description: Matching payers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayerSearchResponse'
        '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:
    PayerSearchResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Use as `payer_id` on an eligibility check.
                example: '60054'
              name:
                type: string
                example: Aetna
            required:
              - id
              - name
      required:
        - data
    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
  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.