> ## Documentation Index > Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Faxes > Returns a cursor-paginated list of faxes, most recent first. Defaults to the last 7 days; pass explicit `created_after` and `created_before` to widen or narrow the window. ## OpenAPI ````yaml /openapi.json get /faxes openapi: 3.1.0 info: title: mintfax API version: '1.0' description: >- Developer-first fax API. Send faxes with a single API call. ## Authentication Most endpoints require a Bearer token in the `Authorization` header. - **Account keys** (`mfx_acct_...`) access account-level endpoints (`/account`, `/account/balance`, `/account/transactions`, `/account/keys`). - **Environment keys** (`mfx_test_...` for test, `mfx_live_...` for live) access operational endpoints (`/environment`, `/faxes`, `/webhooks`, `/events`). - Registration endpoints (`POST /account/register` and `POST /account/register/verify`) do not require authentication. ## Base URL All API requests use `https://api.mintfax.com/v1` as the base URL. contact: name: mintfax Support email: support@mintfax.com url: https://mintfax.com/docs servers: - url: https://api.mintfax.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: >- Account-level resources: registration, account info, balances, and API keys. - name: Environment description: >- Test and live environment configuration shared across all operational requests. - name: Fax description: Send, list, retrieve, resend, and purge faxes. - name: Events description: >- Read the immutable event log for everything that has happened in the environment. - name: Webhooks description: >- Manage webhook endpoints and inspect or replay individual delivery attempts. paths: /faxes: get: tags: - Fax summary: List Faxes description: |- Returns a cursor-paginated list of faxes, most recent first. Defaults to the last 7 days; pass explicit `created_after` and `created_before` to widen or narrow the window. operationId: listFaxes parameters: - name: status in: query schema: $ref: '#/components/schemas/FaxStatus' - name: created_after in: query schema: type: - string - 'null' format: date-time - name: created_before in: query schema: type: - string - 'null' format: date-time - name: to in: query description: E.164 destination number, exact match. schema: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ example: '+12125551234' - name: error_code in: query schema: type: - string - 'null' maxLength: 64 - name: tag[] in: query description: >- Filter by tag values. Use `tag[KEY]=VALUE`. Multiple tag filters compose with AND. schema: type: array items: type: string maxLength: 255 example: '1234' - name: cursor in: query schema: type: - string - 'null' - name: per_page in: query schema: type: - integer - 'null' minimum: 1 maximum: 100 responses: '200': description: Array of `FaxResource` content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/FaxResource' required: - data '401': description: The provided API key is not recognised. content: application/json: schema: $ref: '#/components/schemas/Error' examples: api_key_invalid: value: error: api_key_invalid message: The provided API key is not recognised. action: check_credentials docs: https://mintfax.com/docs/errors/api-key-invalid '403': description: >- Live calls require account activation. Complete a first credit purchase to activate. content: application/json: schema: $ref: '#/components/schemas/Error' examples: account_not_activated: value: error: account_not_activated message: >- Live calls require account activation. Complete a first credit purchase to activate. action: activate_account docs: https://mintfax.com/docs/errors/account-not-activated key_not_scoped_for_operations: value: error: key_not_scoped_for_operations message: >- This API key cannot send faxes or read environment data. Use an mfx_test_ or mfx_live_ key. action: use_operational_key docs: >- https://mintfax.com/docs/errors/key-not-scoped-for-operations '422': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/Error' examples: validation_failed: value: error: validation_failed message: The request failed validation. action: fix_request docs: https://mintfax.com/docs/errors/validation-failed context: errors: to: - The to field is required. file: - The file field is required. '500': description: >- An unexpected error occurred. Please retry; if the problem persists, contact support. content: application/json: schema: $ref: '#/components/schemas/Error' examples: internal_server_error: value: error: internal_server_error message: >- An unexpected error occurred. Please retry; if the problem persists, contact support. action: retry_or_contact_support docs: https://mintfax.com/docs/errors/internal-server-error components: schemas: FaxStatus: type: string enum: - queued - submitted - in_progress - delivered - failed title: FaxStatus FaxResource: type: object properties: id: type: string description: Unique fax identifier (fax_-prefixed). examples: - fax_8aZqRm4yT3vK7pNxJ2bH9c status: $ref: '#/components/schemas/FaxStatus' description: Current fax status. examples: - queued to: type: - string - 'null' description: Destination fax number in E.164 format. examples: - '+12125551234' pages: type: - integer - 'null' description: Number of pages, null until processing begins. error_code: type: - string - 'null' description: Machine-readable failure code, if any. error_subcode: type: string description: Optional finer-grained mintfax-owned subcode, if any. error_message: type: - string - 'null' description: Human-readable failure description, if any. max_attempts: type: string description: Configured retry cap for this fax (1-5). See ADR-021. examples: - '3' attempts: type: array description: Per-attempt delivery detail in chronological order. See ADR-021. items: type: object properties: attempt_number: type: integer started_at: type: string completed_at: type: - string - 'null' duration_ms: type: - integer - 'null' error_code: type: - string - 'null' error_subcode: type: - string - 'null' error_message: type: - string - 'null' required: - attempt_number - started_at - completed_at - duration_ms - error_code - error_subcode - error_message webhook_url: type: - string - 'null' description: Per-fax webhook override URL. idempotency_key: type: - string - 'null' description: Caller-supplied idempotency key. tags: type: object description: Caller-supplied metadata map. Empty serializes as `{}`. additionalProperties: type: string csid: type: - string - 'null' description: Sender CSID transmitted in the T.30 fax handshake (max 20 chars). page_size: anyOf: - $ref: '#/components/schemas/PageSize' description: >- Target page size for content mintfax renders. PDF inputs pass through unchanged. - type: 'null' resolution: anyOf: - $ref: '#/components/schemas/FaxResolution' description: T.30 transmission resolution. - type: 'null' optimize_for: anyOf: - $ref: '#/components/schemas/FaxOptimization' description: Rasterizer optimization hint for non-PDF inputs. - type: 'null' submitted_at: type: - string - 'null' format: date-time description: >- UTC timestamp when the fax was submitted to a carrier. Null until submission. completed_at: type: - string - 'null' format: date-time description: >- UTC timestamp when the fax reached a terminal status. Null until completion. created_at: type: string format: date-time description: UTC timestamp when the fax record was created. updated_at: type: string format: date-time description: UTC timestamp when the fax record was last updated. required: - id - status - to - pages - error_code - error_subcode - error_message - max_attempts - attempts - webhook_url - idempotency_key - tags - csid - page_size - resolution - optimize_for - submitted_at - completed_at - created_at - updated_at title: FaxResource Error: type: object properties: error: type: string description: Machine-readable error code. example: insufficient_balance message: type: string description: Human-readable description. example: Insufficient balance for this operation. action: type: string description: Suggested next step for the caller. example: top_up_balance docs: type: string format: uri description: URL to the docs entry for this error code. example: https://mintfax.com/docs/errors/insufficient-balance request_id: type: string description: >- Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage. pattern: ^req_[0-9A-HJKMNP-TV-Z]{26}$ example: req_01J9XYZQ8KH7B3R0WXAZP8VW6F context: type: object description: Error-specific extra fields (e.g. balances, validation errors). additionalProperties: [] required: - error - message - action - docs - request_id title: Error PageSize: type: string enum: - letter - legal - a4 - b4 title: PageSize FaxResolution: type: string enum: - standard - fine title: FaxResolution FaxOptimization: type: string enum: - text - photo title: FaxOptimization securitySchemes: bearerAuth: type: http description: |- API key as Bearer token. Use an account key (`mfx_acct_...`) for `/account/*` endpoints, and an environment key (`mfx_test_...` for sandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`, `/webhooks`, and `/events`. scheme: bearer ````