Get a Fax

Returns the full fax record including status, error details, and timing.

GET /faxes/{fax}

Get a Fax

cURL

curl --request GET \
  --url https://api.mintfax.com/v1/faxes/{fax} \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "id": "<string>",
  "to": "<string>",
  "pages": 123,
  "error_code": "<string>",
  "error_subcode": "<string>",
  "error_message": "<string>",
  "max_attempts": "<string>",
  "attempts": [
    {
      "attempt_number": 123,
      "started_at": "<string>",
      "completed_at": "<string>",
      "duration_ms": 123,
      "error_code": "<string>",
      "error_subcode": "<string>",
      "error_message": "<string>"
    }
  ],
  "webhook_url": "<string>",
  "idempotency_key": "<string>",
  "tags": {},
  "csid": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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.

Path Parameters

fax · string · required

The fax public id

Response

200

application/json

FaxResource

id · string · required

Unique fax identifier (fax_-prefixed).

Example:

"fax_8aZqRm4yT3vK7pNxJ2bH9c"

status · enum<string> · required

Current fax status.

Available options: queued, submitted, in_progress, delivered, failed

Example:

"queued"

to · string | null · required

Destination fax number in E.164 format.

Example:

"[phone]"

pages · integer | null · required

Number of pages, null until processing begins.

error_code · string | null · required

Machine-readable failure code, if any.

error_subcode · string · required

Optional finer-grained mintfax-owned subcode, if any.

error_message · string | null · required

Human-readable failure description, if any.

max_attempts · string · required

Configured retry cap for this fax (1-5). See ADR-021.

Example:

"3"

attempts · object[] · required

Per-attempt delivery detail in chronological order. See ADR-021.

Show child attributes

webhook_url · string | null · required

Per-fax webhook override URL.

idempotency_key · string | null · required

Caller-supplied idempotency key.

tags · object · required

Caller-supplied metadata map. Empty serializes as {}.

Show child attributes

csid · string | null · required

Sender CSID transmitted in the T.30 fax handshake (max 20 chars).

page_size · enum<string> | null · required

Target page size for content mintfax renders. PDF inputs pass through unchanged.

Available options: letter, legal, a4, b4

resolution · enum<string> | null · required

T.30 transmission resolution.

Available options: standard, fine

optimize_for · enum<string> | null · required

Rasterizer optimization hint for non-PDF inputs.

Available options: text, photo

submitted_at · string<date-time> | null · required

UTC timestamp when the fax was submitted to a carrier. Null until submission.

completed_at · string<date-time> | null · required

UTC timestamp when the fax reached a terminal status. Null until completion.

created_at · string<date-time> · required

UTC timestamp when the fax record was created.

updated_at · string<date-time> · required

UTC timestamp when the fax record was last updated.