List fax logs

Lists your account's sent and received faxes, newest first, a page at a time, with total, the number of faxes matching your filters.

Who may call it: an API key with All permissions, for every fax server of your account. A Scoped key sees no fax servers: its pages are empty.

Use it:

  • Follow sent faxes: fx_mode=tx and fax_status=queued,media.processed,sending,failed. A failed fax is final only when fax_result_code is 99, which the list doesn't show: read it from GET /fax/logs/{logId}.
  • New received faxes: fx_mode=rx, fax_date_gte set to your last check, and hide_failed_receives=true.
  • Page with page (from 0) and limit until (page + 1) * limit reaches total.

Response: rows, total, page and limit. This is the summary shape: retries, email deliveries and access history come from GET /fax/logs/{logId}.

Notes:

  • search matches any part of the numbers, names and subject, ignoring case. ( ) , . * are dropped and the term is cut at 100 characters.
  • A fax_status value nobody uses simply matches nothing.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

One fax server's faxes only.

string
enum

tx for sent faxes, rx for received ones.

Allowed:
string

One status, or several separated by commas: delivered, failed,cancelled.

string
enum

true for archived faxes only, false for the others. Any other value is ignored.

Allowed:
string
enum

true for faxes whose document was deleted, false for the others.

Allowed:
date-time

Faxes from this instant on, inclusive (ISO 8601).

date-time

Faxes up to this instant, inclusive (ISO 8601).

Text to find in the from and to numbers and names and the subject.

string
enum
Defaults to false

true leaves out received faxes that failed, usually a dropped line on the sender's side. Default false.

Allowed:
integer
≥ 0
Defaults to 0

The page, from 0. A negative or non-numeric value reads as 0.

integer
1 to 500
Defaults to 10

Faxes per page, 1 to 500 (default 10). Larger values are cut to 500; 0, negative or non-numeric values read as 10.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json