Inboxes

List inboxes

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.

GET
/inboxes

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.

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

Query Parameters

limit?integer

Page size, 1-100. Defaults to 50.

page_token?string

Opaque token from a previous page's next_page_token. Omit for the first page.

ascending?boolean

Sort oldest-first when true. Defaults to newest-first.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/inboxes"
{  "count": 0,  "limit": 0,  "next_page_token": "string",  "inboxes": [    {      "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": "validation",  "errors": {    "property1": "string",    "property2": "string"  }}
{  "name": "string",  "message": "string"}

Get an inbox GET

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.

Update an inbox PATCH

Partially update an inbox's `display_name` and/or `metadata`. At least one field must be supplied. Metadata merges: supplied keys are set, a key with a `null` value is removed, and `metadata: null` clears all metadata. The `email` address is immutable.