Skip to main content
GET
List inbox messages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Inbox ID.

Required range: x >= 1

Query Parameters

limit
integer
default:20

Maximum messages to return, newest first (max 100).

Required range: 1 <= x <= 100
received_after
string<date-time>

Only messages received at or after this ISO 8601 time. Messages from before the claim are never returned.

from
string

Only messages whose sender contains this text.

Minimum string length: 1
subject
string

Only messages whose subject contains this text.

Minimum string length: 1
body
string

Only messages whose text or HTML body contains this text.

Minimum string length: 1

Response

The inbox's messages.

data
object
required

Response payload.