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.

GET /faxes

List Faxes

cURL

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

200

Example

{
  "data": [
    {
      "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.

Query Parameters

status · enum<string>

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

created_after · string<date-time> | null

created_before · string<date-time> | null

to · string | null

E.164 destination number, exact match.

Pattern: ^\+[1-9]\d{1,14}$

error_code · string | null

Maximum string length: 64

tag[] · string[]

Filter by tag values. Use tag[KEY]=VALUE. Multiple tag filters compose with AND.

Maximum string length: 255

cursor · string | null

per_page · integer | null

Required range: 1 <= x <= 100

Response

200

application/json

Array of FaxResource

data · FaxResource · object[] · required

Show child attributes