Get an inbox

Returns a single inbox.

get

Authorizations

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

inbox_idintegerRequired

Inbound inbox ID

Example: 1

Responses

200

Inbox details

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: [e-mail]

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

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get/api/inbound/folders/{folder_id}/inboxes/{inbox_id}

curl -X GET https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes/{inbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "id": 1,
  "name": "Support tickets",
  "address": "[e-mail]",
  "domain_id": 892
}