Skip to main content
GET
Get a fax

Path Parameters

slug
string
required

The fax's slug, from the list response or from its faxbeep.com URL: fax_ followed by hexadecimal characters.

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

Response

The requested fax.

A test fax or scan, as displayed on faxbeep.com. The sender is masked.

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"