For the complete documentation index, see llms.txt. This page is also available as Markdown.

List inboxes

Returns all inboxes in a folder.

get
Authorizations
Api-TokenstringRequired

API token in Api-Token header

Path parameters
folder_idintegerRequired

Inbound folder ID

Example: 1
Responses
200

List of inboxes

application/json
idintegerOptionalExample: 1
namestringOptionalExample: Support tickets
addressstringOptional

The inbox's inbound address. For a standard Mailtrap-hosted inbox this is a unique generated address. For a custom-domain inbox it is the catch-all form *@your-domain.com, which receives mail sent to any address on that domain.

Example: support-tickets-1a2b3c4d@inbound-mailtrap.io
domain_idintegerOptional

ID of the sending domain the inbox is attached to. For a custom-domain inbox this is your own sending domain; for a standard hosted inbox it is the Mailtrap-managed domain backing the inbox.

Example: 892
get/api/inbound/folders/{folder_id}/inboxes
curl -X GET https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes \
  -H 'Authorization: Bearer YOUR_API_KEY'
[
  {
    "id": 1,
    "name": "Support tickets",
    "address": "support-tickets-1a2b3c4d@inbound-mailtrap.io",
    "domain_id": 892
  },
  {
    "id": 2,
    "name": "Replies",
    "address": "*@your-domain.com",
    "domain_id": 894
  }
]

Last updated

Was this helpful?