Skip to main content
GET
List faxes

Query Parameters

limit
integer
default:20

Number of faxes to return, from 1 to 100.

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

Returns only faxes received after this time, compared to the second. ISO 8601 with an offset: 2026-10-01T14:25:00Z, 2026-10-01T16:25:00+02:00, or 2026-10-01T16:25:00+0200. Fractional seconds of any length are accepted. A date on its own, or a time without an offset, returns 422. Use UTC with Z, or encode the + of an offset as %2B. Default: 24 hours ago.

from
string

Returns only faxes from this sender. Use the full phone number, station ID, or email address, not the masked form. Matching ignores case, spaces in a station ID, and the + of a phone number. There is no prefix or wildcard matching. Unknown returns faxes without a sender ID. Encode + as %2B. Maximum 255 characters.

Maximum string length: 255

Response

A JSON array of faxes, newest first, or an empty array ([]) if no fax matches.

slug
string
required

The fax's ID. Use it with GET /api/faxes/{slug}.

Example:

"fax_5dd79a1c"

source
enum<string>
required

phone for a fax sent over a phone line, email for a scan to email or Internet Fax test.

Available options:
phone,
email
Example:

"phone"

from
string | null
required

The sender, masked as on faxbeep.com: the middle 5 digits of a number are hidden, and an address is displayed as s***@e***.com. A station ID with fewer than 6 digits is displayed unchanged. null if the fax arrived without a sender ID (displayed as Unknown on faxbeep.com).

Example:

"+155*****123"

received_at
string<date-time>
required

When the fax arrived, in UTC with Z. since is compared with this time. The fax appears in the API later, once processing finishes.

Example:

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

page_count
integer | null
required

Number of pages. null if the fax couldn't be processed.

Example:

3

file_size
integer | null
required

PDF size in bytes. null if the fax couldn't be processed.

Example:

245678

pdf_url
string<uri> | null
required

URL of the fax PDF. null if the fax couldn't be processed.

Example:

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

thumbnail_url
string<uri> | null
required

URL of an image of the first page. null if the fax couldn't be processed or no image of the first page could be created. A null thumbnail doesn't mean the PDF is unavailable: check pdf_url.

Example:

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

view_url
string<uri>
required

URL of the fax's page on faxbeep.com.

Example:

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