List fax logs

get

https://api.emaktalk.com/api/v1/fax/logs

Returns a page of the faxes sent and received on your account, along with total, the exact number of faxes matching your filters, so you can page through them. If your key is limited to particular fax servers, only faxes on those appear — filtering by a fax server you are not assigned returns an empty page rather than an error. This is the summary shape; retries, email tracing and access history come from GET /api/v1/fax/logs/{logId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

fax_uuid

string

Limit to one fax server. For keys restricted to particular fax servers, an unassigned id returns an empty page.

fx_mode

string

rx for received faxes or tx for sent ones; any other value is rejected.

fax_status

string

One status, or several separated by commas.

fax_archived

string

true or false; any other value is ignored.

is_deleted

string

true or false, matching faxes whose document has been deleted.

fax_date_gte

string

Inclusive earliest fax date, as an ISO timestamp.

fax_date_lte

string

Inclusive latest fax date, as an ISO timestamp.

string

Case-insensitive substring match across the from and to numbers, the from and to names, and the subject; ( ) , . * are stripped and the term is cut to 100 characters.

hide_failed_receives

string

true hides received faxes that failed, which are usually transient inbound line drops. Defaults to false.

page

integer

Zero-based page index, default 0. Negative or non-numeric values fall back to 0.

limit

integer

Faxes per page, default 10, capped at 500.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of faxes plus the total number of matches.

400fx_mode is not rx or tx, or the query failed.

403The request is not authenticated, or it named an account you do not have access to.