Skip to main content
GET
Get a fax

Path Parameters

slug
string
required

The slug of the fax, from the list or from the URL of its page on faxbeep.com: fax_ and hexadecimal characters.

Pattern: ^fax_[a-f0-9]+$

Response

The fax.

A test fax or scan, as faxbeep.com shows it. The sender is masked.

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"