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

> Read-only, paginated list of the providers (clinicians) in your organization. The provider `id` is the stable internal identifier to map against your own directory and to pass as `provider_id` on patients and appointments. Pass `npi=<value>` to look up a single provider by their individual (type-I) NPI.



## OpenAPI

````yaml /openapi/ext-api-v1.json get /providers
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 for pulling clinical notes (with transcript and patient
    context).
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /providers:
    get:
      tags:
        - Providers
      summary: List providers
      description: >-
        Read-only, paginated list of the providers (clinicians) in your
        organization. The provider `id` is the stable internal identifier to map
        against your own directory and to pass as `provider_id` on patients and
        appointments. Pass `npi=<value>` to look up a single provider by their
        individual (type-I) NPI.
      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
            description: >-
              Look up a single provider by individual (type-I) NPI (bypasses
              pagination; returns 404 if no match).
            example: '1234567890'
          required: false
          name: npi
          in: query
      responses:
        '200':
          description: List of providers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: npi lookup miss
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    ProviderListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Provider'
        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
    Provider:
      type: object
      properties:
        id:
          type: string
          description: >-
            Internal provider identifier (HealOS user id). Stable — map this to
            your own provider directory and pass it as `provider_id` when
            creating patients and appointments.
          example: aaaaaaa1-0000-0000-0000-000000000001
        name:
          type: string
          nullable: true
          description: Provider display name
          example: Dr. Alice Nguyen
        email:
          type: string
          nullable: true
          description: Provider email
          example: alice.nguyen@cancercenter.example
        npi:
          type: string
          nullable: true
          description: >-
            Individual (type-I) National Provider Identifier, when recorded for
            this provider.
          example: '1234567890'
        title:
          type: string
          nullable: true
          description: Professional title/credential
          example: MD
        specialty:
          type: string
          nullable: true
          description: Provider specialty
          example: Oncology
        role:
          type: string
          description: Role within the organization
          example: member
        joined_at:
          type: string
          description: When the provider joined the organization (ISO 8601)
          example: '2026-01-15T09:30:00.000Z'
      required:
        - id
        - name
        - email
        - npi
        - title
        - specialty
        - role
        - joined_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````