Skip to navigation
FreeCustom.Email APIV1Inboxes

List inboxes

View as Markdown

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