Skip to main content
GET
/
fax
/
{id}
cURL
curl https://api.mintfax.com/v1/fax/9c1a2b3d-4e5f-6789-abcd-ef0123456789 \
  -H "Authorization: Bearer fx_test_abc123..."
{
  "id": "9c1a2b3d-4e5f-6789-abcd-ef0123456789",
  "status": "queued",
  "to": "+12125551234",
  "retries_remaining": 3,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "pages": 3,
  "carrier": "<string>",
  "carrier_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "webhook_url": "<string>",
  "idempotency_key": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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.

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Sandbox keys (fx_test_...) route to the sandbox environment. Live keys (fx_live_...) route to production.

Path Parameters

​
id
string<uuid>
required

Fax ID

Response

Fax record

​
id
string<uuid>
required

Unique fax identifier

Example:

"9c1a2b3d-4e5f-6789-abcd-ef0123456789"

​
status
enum<string>
required

Current fax status

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

"queued"

​
to
string
required

Destination fax number in E.164 format

Example:

"+12125551234"

​
retries_remaining
integer
required

Number of retry attempts remaining

Example:

3

​
created_at
string<date-time>
required

When the fax record was created

Example:

"2026-01-15T10:30:00Z"

​
updated_at
string<date-time>
required

When the fax record was last updated

​
pages
integer | null

Number of pages (null until processing begins)

Example:

3

​
carrier
string | null

Carrier used for delivery

​
carrier_id
string | null

Carrier-assigned fax identifier

​
error_code
string | null

Machine-readable error code on failure

​
error_message
string | null

Human-readable error description on failure

​
webhook_url
string<uri> | null

Per-fax webhook override URL

​
idempotency_key
string | null

Client-provided idempotency key

​
submitted_at
string<date-time> | null

When the fax was submitted to the carrier

​
completed_at
string<date-time> | null

When the fax reached a terminal state