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

# List faxes

> Returns a paginated list of faxes sent by this application, newest first.



## OpenAPI

````yaml /openapi-v2.json get /faxes
openapi: 3.0.0
info:
  title: Max AI Public API
  description: API for third-party marketplace apps
  version: '2.0'
  contact: {}
servers:
  - url: https://api.maxcare.ai/v2
security: []
tags: []
paths:
  /faxes:
    get:
      tags:
        - Faxes
      summary: List faxes
      description: >-
        Returns a paginated list of faxes sent by this application, newest
        first.
      operationId: FaxesPublicController_listFaxes
      parameters:
        - name: page
          required: false
          in: query
          description: Page number (1-indexed)
          schema:
            default: 1
            example: 1
        - name: pageSize
          required: false
          in: query
          description: Number of items per page (max 100)
          schema:
            default: 100
            example: 100
        - name: patientId
          required: false
          in: query
          description: Filter by patient
          schema:
            example: 8de03039-3a9e-417a-b2b3-a8b8df183631
            type: string
        - name: status
          required: false
          in: query
          description: Filter by delivery status
          schema:
            example: delivered
            enum:
              - sent
              - delivered
              - failed
            type: string
        - name: X-Organization-Id
          in: header
          required: true
          schema:
            type: string
          description: Target clinic organization ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFaxesSuccessResponse'
        '400':
          description: Missing or invalid request parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBadRequestResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiUnauthorizedResponse'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiForbiddenResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiRateLimitResponse'
      security:
        - api-key: []
components:
  schemas:
    ListFaxesSuccessResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code
          example: success
        data:
          $ref: '#/components/schemas/ListFaxesResponseData'
      required:
        - code
        - data
    PublicApiBadRequestResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: bad_request
        message:
          type: string
          description: Human-readable error message
          example: '''id'' must be a valid UUID'
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiUnauthorizedResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: unauthorized
        message:
          type: string
          description: Human-readable error message
          example: Invalid or missing API key
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiForbiddenResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: forbidden
        message:
          type: string
          description: Human-readable error message
          example: Insufficient scope
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiRateLimitResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: rate_limit_exceeded
        message:
          type: string
          description: Human-readable error message
          example: Rate limit exceeded. Maximum 1000 requests per 60 seconds.
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    ListFaxesResponseData:
      type: object
      properties:
        faxes:
          type: array
          items:
            $ref: '#/components/schemas/ExternalFaxResponse'
        pagination:
          $ref: '#/components/schemas/PaginationInfoResponse'
      required:
        - faxes
        - pagination
    ExternalFaxResponse:
      type: object
      properties:
        id:
          type: string
          description: Fax record ID
          example: a7c3f1e2-8b4d-4a9e-b5c6-d7e8f9012345
        patientId:
          type: string
          description: Patient the fax was sent for
          example: 8de03039-3a9e-417a-b2b3-a8b8df183631
        toNumber:
          type: string
          description: Destination fax number, normalized to digits
          example: '7347148907'
        recipientName:
          type: string
          description: Recipient name when supplied
          nullable: true
          example: McLaren Health Plan
        subject:
          type: string
          description: Cover page line
          nullable: true
          example: Prior Auth Request
        status:
          type: string
          description: >-
            Delivery status. `sent` means the EHR accepted it and delivery is
            not yet confirmed; it settles to `delivered` or `failed` within
            minutes.
          enum:
            - sent
            - delivered
            - failed
          example: delivered
        errorKind:
          type: string
          description: >-
            Why a failed fax failed. Null unless status is failed. One of
            `ehr_send_failed` (the EHR refused the send), `invalid_request` (the
            number or the attachment is wrong — retrying the same request cannot
            help), `transmission_failed` (busy, no answer, not a fax machine),
            `not_found_in_outbox`, `ambiguous_outbox_match`, `still_processing`,
            `send_interrupted`, `patient_unresolvable`, `outbox_unreadable`,
            `unknown_status`. Only the first three are definite.
            `not_found_in_outbox` and everything after it mean the outcome is
            UNKNOWN — the fax may have been delivered, so do not blind-retry.
          nullable: true
          example: transmission_failed
        statusDetail:
          type: string
          description: The EHR's own description of the outcome
          nullable: true
          example: successfully delivered
        pagesSent:
          type: number
          description: Pages transmitted, once known
          nullable: true
          example: 15
        attachmentIds:
          description: Chart document IDs (EHR-native) that were faxed
          example:
            - '201269302'
          type: array
          items:
            type: string
        sentAt:
          type: string
          description: >-
            When the send was issued to the EHR — anchored just BEFORE the
            request, because it is the floor the outbox correlation matches
            against. It is not an acceptance time and not a delivery time: a
            `failed` fax carries one too. Read `status` and `errorKind` for what
            actually happened.
          example: '2026-08-26T03:20:20.000Z'
        deliveredAt:
          type: string
          description: When delivery was confirmed
          nullable: true
          example: '2026-08-26T03:25:00.000Z'
        failedAt:
          type: string
          description: When the fax terminally failed
          nullable: true
          example: null
        createdAt:
          type: string
          description: Created timestamp
          example: '2026-08-26T03:20:19.000Z'
      required:
        - id
        - patientId
        - toNumber
        - recipientName
        - subject
        - status
        - errorKind
        - statusDetail
        - pagesSent
        - attachmentIds
        - sentAt
        - deliveredAt
        - failedAt
        - createdAt
    PaginationInfoResponse:
      type: object
      properties:
        page:
          type: number
          description: Current page number
          example: 1
        pageSize:
          type: number
          description: Items per page
          example: 100
        totalCount:
          type: number
          description: Total number of items
          example: 250
        totalPages:
          type: number
          description: Total number of pages
          example: 3
      required:
        - page
        - pageSize
        - totalCount
        - totalPages
  securitySchemes:
    api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Marketplace API key

````