Developers

Read the result of a Faxbeep test from a script or a CI job: a free, public, read-only API with no account.

The Faxbeep API gives the tests that faxbeep.com shows as JSON. Use it when you test a fax API, a fax server or a scanner, and a script must check that the test arrived. Send the test with your own provider or machine, then read the result from the API.

The API is read-only. Faxbeep only receives: it does not send faxes, and the API cannot send one.

Each test is public for 30 days. Anyone can open it on faxbeep.com. Use a test page with no personal or confidential data. To remove a test sooner, see Remove a fax.

What you can do

• List the newest tests, by phone and by email together.
• Find your test by time, by sender, or by email address.
• Get one test by its slug, again later.
• Get the PDF, an image of the first page, and the link to its page on faxbeep.com.

The rules

Rule	Value
Account and token	None. Each call is a public GET request.
Price	Free
Privacy	Each test is public for 30 days. There is no private mode.
Rate limit	60 requests each minute for one IP address
Tests in one call	20 by default, 100 at most. There is no paging.
Time the list spans	The last 24 hours, unless you give since
Sender	Masked, as on faxbeep.com. Most faxes by phone arrive with no sender ID.
Notifications	None. Your script asks the API again until the test appears.
Time to appear	Usually 1 to 2 minutes after the call ends, or after your machine sends the email

The limits for the tests themselves, such as 60 email tests each hour from one sender address, are in Limits.

Next

Find your fax

By time, by sender, or by email address.

Station ID

Why most faxes by phone arrive with no sender, and when a sender ID is shared.

Test in CI

A script that waits for your fax, in curl, Node and Python.

API reference

The base URL, the rate limit, the errors and the two endpoints.