> ## Documentation Index
> Fetch the complete documentation index at: https://faxbeep.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Developers

> Check whether a test fax or scan has arrived at Faxbeep from a script or CI job, using the read-only JSON API.

Use the Faxbeep API to check whether a test fax or scan has arrived. It's useful when you test a fax API, a fax server, or a scanner and want a script to confirm delivery. Send the test from your own machine or fax provider, then request the result as JSON.

The API is read-only and needs no account or token. It can't send faxes.

An AI agent can read the same results through the [MCP server](https://faxbeep.mintlify.site/developers/mcp.md).

> [!WARNING]
>
> Each test is public for 30 days. Anyone can open it on faxbeep.com. Use a test page with no personal or confidential information. To remove a test early, see [Remove a fax](https://faxbeep.mintlify.site/privacy/remove-a-fax.md).

## API limits and behavior

| Topic | Details |
| - | - |
| Authentication | None. Every request is a public GET request. |
| Price | Free |
| Privacy | Each test is public for 30 days. There is no private mode. |
| Rate limit | 60 requests per minute per IP address |
| Results | 20 tests by default, up to 100, newest first. There is no pagination. |
| Time window | The last 24 hours, unless you set `since` |
| Sender | Masked, as on faxbeep.com. Most faxes sent over a phone line arrive without a sender ID. |
| Notifications | None. To wait for a test, poll: repeat the request at an interval until the test appears. |
| Arrival time | Usually within a minute after the call ends or after your machine sends the email |
| Content | Each test includes its source, sender, arrival time, and page count, links to its PDF and its faxbeep.com page, and a thumbnail link |

Limits on the tests themselves, such as 60 email tests per hour from one sender address, are on the [Limits](https://faxbeep.mintlify.site/reference/limits.md) page.

## Next steps

> [card] [Find your fax](https://faxbeep.mintlify.site/developers/find-your-fax.md)
>
> Narrow the results by time, sender, or email address.

> [card] [Station ID](https://faxbeep.mintlify.site/developers/station-id.md)
>
> Why most faxes arrive without a sender, and when a sender ID is shared.

> [card] [Test in CI](https://faxbeep.mintlify.site/developers/ci.md)
>
> Poll for a received fax from a CI job, in curl, Node, and Python.

> [card] [API reference](https://faxbeep.mintlify.site/api-reference/introduction.md)
>
> Base URL, rate limit, errors, and endpoints.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.