> ## 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 sent fax

> One sent fax and its stored delivery status. The status is what HealOS last recorded; this read never contacts the fax provider. Another organization's fax is a 404. Requires the fax:read scope.

| Requirement | Detail |
| - | - |
| **Scope** | `fax:read` (rolling out: not yet on `api.healos.ai`) |
| **Rate limit** | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| **Cost** | Free |

> [!TIP]
>
> **Safety**
>
> * **Writes data:** No
> * **Safe to retry:** Yes
> * **Contacts an outside system:** None
> * **Dry run:** Not needed (read-only).

The status is what HealOS last recorded; this read does not ask the fax provider again.

Errors: [Error catalog](https://docs.healos.ai/errors.md).


## OpenAPI

````yaml openapi/ext-api-v1.json GET /faxes/outbound/{outboundFaxId}
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), running insurance eligibility checks, browsing the EHR
    action catalog, reading AI Receptionist calls (summary, transcript,
    extracted details and recording), managing the AI Receptionist inbox tasks,
    and registering webhooks for note and document events.
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /faxes/outbound/{outboundFaxId}:
    get:
      tags:
        - Fax
      summary: Get a sent fax
      description: >-
        One sent fax and its stored delivery status. The status is what HealOS
        last recorded; this read never contacts the fax provider. Another
        organization's fax is a 404. Requires the fax:read scope.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Outbound fax identifier, from GET /faxes/outbound.
            example: 0f000000-0000-4000-8000-000000000001
          required: true
          name: outboundFaxId
          in: path
      responses:
        '200':
          description: The sent fax
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundFaxResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope (needs fax:read)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Outbound fax 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:
    OutboundFaxResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OutboundFax'
      required:
        - data
    ValidationError:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - error
    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.
        code:
          type: string
          enum:
            - daily_cap_reached
          description: >-
            Set when the organization reached its daily cap for this paid
            operation (not on a per-minute limit).
        reset_at:
          type: string
          format: date-time
          description: 'With `code`: when the daily cap resets (next 00:00 UTC).'
          example: '2026-10-28T00:00:00.000Z'
      required:
        - error
    OutboundFax:
      type: object
      properties:
        id:
          type: string
          example: 0f000000-0000-4000-8000-000000000001
        created_at:
          type: string
        to_number:
          type: string
          example: '+15555550199'
        to_name:
          type: string
          nullable: true
        subject:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - queued
            - submitting
            - sending
            - delivered
            - failed
            - canceled
        status_detail:
          type: string
          nullable: true
          description: The fax provider's status text, when it gave one.
        pages_sent:
          type: integer
          nullable: true
        total_pages:
          type: integer
          nullable: true
        fax_id:
          type: string
          nullable: true
          description: The inbound fax this one forwarded, when it was a forward.
        retry_count:
          type: integer
        delivered_at:
          type: string
          nullable: true
        failed_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
      required:
        - id
        - created_at
        - to_number
        - to_name
        - subject
        - status
        - status_detail
        - pages_sent
        - total_pages
        - fax_id
        - retry_count
        - delivered_at
        - failed_at
        - canceled_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.