For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • FreeCustom.Email API
        • GETList inboxes
        • POSTRegister an inbox
LogoLogo
FreeCustom.Email APIV1Inboxes

List inboxes

||View as Markdown|
GET
https://api2.freecustom.email/v1/inboxes
GET
/v1/inboxes
$curl https://api2.freecustom.email/v1/inboxes \
> -H "Authorization: Bearer <token>"
1{
2 "success": true,
3 "data": {
4 "inboxes": [
5 "string",
6 "string"
7 ],
8 "count": 4706
9 }
10}
Returns all inboxes registered to your account, including both platform-domain and custom-domain inboxes. **Response fields (per inbox):** - `inbox` — Full email address of the inbox - `domain` — Domain portion of the address - `createdAt` — ISO 8601 timestamp of when the inbox was registered - `expiresAt` — Expiry timestamp (based on your plan's persistence tier) - `messageCount` — Number of messages currently stored **Behaviour:** - Returns an empty array `[]` if no inboxes are registered. - Inboxes are returned in descending order of creation time (newest first). **Plan:** All plans (Free and above).
Was this page helpful?
Previous

Verify a custom domain

Next

Register an inbox

Built with

Returns all inboxes registered to your account, including both platform-domain and custom-domain inboxes.

Response fields (per inbox):

  • inbox — Full email address of the inbox
  • domain — Domain portion of the address
  • createdAt — ISO 8601 timestamp of when the inbox was registered
  • expiresAt — Expiry timestamp (based on your plan’s persistence tier)
  • messageCount — Number of messages currently stored

Behaviour:

  • Returns an empty array [] if no inboxes are registered.
  • Inboxes are returned in descending order of creation time (newest first).

Plan: All plans (Free and above).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
successboolean
dataobject

Errors

401
Unauthorized Error
429
Too Many Requests Error