Skip to main content
GET
List Inbound Emails

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
status
enum<string> | null

Filter by status: pending, success, or failed. Takes precedence over processed if both are provided.

Available options:
pending,
success,
failed
processed
boolean | null

Filter by processing status. If not provided, returns all. Ignored when status is set.

received_from
string<date-time> | null

Inclusive lower bound on received date (falls back to created_at when received_at is null)

received_to
string<date-time> | null

Inclusive upper bound on received date (falls back to created_at when received_at is null)

search
string | null

Case-insensitive search across sender email, subject, message ID, and attachment filenames

sort_by
enum<string>
default:received_at

Field to sort by

Available options:
received_at,
created_at
sort_order
enum<string>
default:desc

Sort direction (asc/desc)

Available options:
asc,
desc

Response

Successful Response

items
InboundEmailResponse · object[]
required
total
integer
required
page
integer
required
page_size
integer
required
pages
integer
required
has_next_page
boolean
required