Skip to main content
GET
List faxes

Query Parameters

limit
integer
default:20

How many faxes to return. From 1 to 100.

Required range: 1 <= x <= 100
since
string<date-time>

Only faxes received strictly later than this time, to the second. ISO 8601 with an offset: 2026-10-01T14:25:00Z or 2026-10-01T16:25:00+02:00. A date alone, or a time with no offset, answers 422. Use UTC with Z. Send the + of an offset as %2B. Default: 24 hours ago.

from
string

Only faxes of this sender: the full phone number, station ID or email address, not the masked form. Case does not matter. A station ID matches with or without spaces. A number matches with or without its +. No prefix and no wildcard. Unknown gives the faxes with no sender ID. Send a + as %2B. 255 characters at most.

Maximum string length: 255

Response

A JSON array of faxes, newest first. An empty array ([]) when no fax matches.

slug
string
required

The ID of the fax. Use it with GET /api/faxes/{slug}.

Example:

"fax_5dd79a1c"

source
enum<string>
required

phone for a fax by phone, email for a scan to email test or an Internet Fax test.

Available options:
phone,
email
Example:

"phone"

from
string | null
required

The sender, masked as on faxbeep.com: a number loses its middle 5 digits, an address shows as s***@e***.com. A station ID with fewer than 6 digits shows as it is. null when the fax arrived with no sender ID (shown as Unknown on the site).

Example:

"+155*****123"

received_at
string<date-time>
required

The time the fax arrived, in UTC with Z. This is the time that since compares. A fax appears in the API later, when its processing is done.

Example:

"2026-10-01T14:30:00Z"

page_count
integer | null
required

The number of pages. null if the fax could not be processed.

Example:

3

file_size
integer | null
required

The size of the PDF, in bytes. null if the fax could not be processed.

Example:

245678

pdf_url
string<uri> | null
required

The PDF of the fax. null if the fax could not be processed.

Example:

"https://cdn.faxbeep.com/faxes/fax_5dd79a1c.pdf"

thumbnail_url
string<uri> | null
required

An image of the first page. null if the fax could not be processed.

Example:

"https://cdn.faxbeep.com/faxes/fax_5dd79a1c-thumb.jpg"

view_url
string<uri>
required

The page of the fax on faxbeep.com.

Example:

"https://faxbeep.com/faxtest/fax_5dd79a1c"