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

# Get a prior-auth request



## OpenAPI

````yaml /openapi/ext-api-v1.json get /prior-auth/requests/{requestId}
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:
  /prior-auth/requests/{requestId}:
    get:
      tags:
        - Prior Auth
      summary: Get a prior-auth request
      parameters:
        - schema:
            type: string
            format: uuid
            example: 5b0e3c1a-2f4d-4c1e-9a43-0d7e1b2c3a4f
          required: true
          name: requestId
          in: path
      responses:
        '200':
          description: The request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriorAuthRequestResponse'
        '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: Not found in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    PriorAuthRequestResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PriorAuthRequest'
      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
    PriorAuthRequest:
      type: object
      properties:
        id:
          type: string
          description: HealOS prior-auth request id
          example: 5b0e3c1a-2f4d-4c1e-9a43-0d7e1b2c3a4f
        track:
          type: string
          enum:
            - covermymeds
            - availity
          description: >-
            `covermymeds`: a medication request HealOS prepares in CoverMyMeds.
            `availity`: a procedure request an EHR workflow (eCW or ModMed)
            files in Availity.
        status:
          type: string
          enum:
            - in_progress
            - needs_review
            - ready_for_person
            - submitted
            - needs_attention
            - failed
            - unknown
          description: >-
            Where HealOS is in the work. `needs_review`: a clinician must review
            the drafted answers. `ready_for_person`: the portal form is filled
            and saved; a person sends it. `submitted`: sent to the plan.
            `needs_attention`/`failed`: HealOS stopped; see the dashboard.
        raw_status:
          type: string
          description: HealOS's internal status, for support
          example: draft_saved
        decision:
          type: string
          nullable: true
          enum:
            - pending
            - approved
            - denied
            - cancelled
            - closed
          description: >-
            The payer's latest decision as the portal shows it; null until the
            request reaches the plan.
        decision_checked_at:
          type: string
          nullable: true
          description: When HealOS last read the decision from the portal
          example: '2026-10-22T14:05:00.000Z'
        payer:
          type: string
          nullable: true
          example: Aetna
        drug_name:
          type: string
          nullable: true
          description: CoverMyMeds requests only
          example: Ozempic 0.5 mg
        diagnosis_code:
          type: string
          nullable: true
          description: CoverMyMeds requests only
          example: E11.9
        portal_ref:
          type: string
          nullable: true
          description: >-
            The portal's own reference: the CoverMyMeds key or the Availity
            reference number
          example: BMK7QX2
        authorization_id:
          type: string
          nullable: true
          description: Availity authorization number, once approved
        effective_date:
          type: string
          nullable: true
          description: Availity authorization start, once approved
        expiration_date:
          type: string
          nullable: true
          description: Availity authorization end, once approved
        ehr_patient_id:
          type: string
          nullable: true
          description: >-
            The patient's id in the EHR the request came from (CoverMyMeds
            requests only)
          example: '140737488355328'
        workflow_id:
          type: string
          nullable: true
          description: The Availity workflow that filed it (Availity requests only)
        created_at:
          type: string
          nullable: true
          description: When HealOS started the request
          example: '2026-10-22T14:05:00.000Z'
        updated_at:
          type: string
          nullable: true
          description: Last change to the request or its decision
          example: '2026-10-22T14:05:00.000Z'
      required:
        - id
        - track
        - status
        - raw_status
        - decision
        - decision_checked_at
        - payer
        - drug_name
        - diagnosis_code
        - portal_ref
        - authorization_id
        - effective_date
        - expiration_date
        - ehr_patient_id
        - workflow_id
        - created_at
        - updated_at
  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.