Inboxes

Get an inbox

Fetch a single inbox by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked.

GET
/inboxes/{inbox_id}

Fetch a single inbox by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked.

Authorization

x-api-key<token>

The per-tenant API key. Sent as the x-api-key request header. The key is tenant-scoped.

In: header

Path Parameters

inbox_id*string

The inbox's opaque id (e.g. inb_…).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/inboxes/string"
{  "inbox_id": "string",  "email": "user@example.com",  "display_name": "string",  "client_id": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}

Delete an inbox DELETE

Hard-delete an inbox and its stored mail; the address is quarantined for a cooling-off period before it can be reused. An unknown, already-deleted, or cross-tenant id returns not-found — a delete is never silently successful on a missing inbox.

List inboxes GET

List the inboxes belonging to the authenticated tenant, newest-first by default, with cursor pagination. An account with no inboxes gets an empty list, not an error.