Skip to main content
GET
List business emails

Authorizations

Authorization
string
header
required

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

Path Parameters

businessId
string<uuid>
required

The UUID of the business whose emails to list.

Query Parameters

received_at_start
string<date-time>

Include messages received at or after this RFC 3339 instant. Inclusive start of the UTC time range.

received_at_end
string<date-time>

Exclude messages received at or after this RFC 3339 instant. Exclusive end of the UTC time range. Must be later than received_at_start when both are given.

has_attachments
boolean

Filter to messages with at least one stored attachment (true) or none (false). Omit to include both.

direction
enum<string>

Filter to received emails or sent replies. Omit to include both.

Available options:
RECEIVED,
SENT
limit
integer
default:100

Maximum messages per page. Defaults to 100.

Required range: 1 <= x <= 1000
cursor
string

Opaque cursor from the previous response's meta.pagination.cursor. Repeat the same filters on subsequent pages.

sort_by
enum<string>
default:received_at

The sort field. Only received_at is supported; this is the default.

Available options:
received_at
sort_order
enum<string>
default:DESC

Order by received_at, then message ID. Defaults to DESC.

Available options:
ASC,
DESC

Response

Business emails retrieved.

data
object[]
required
meta
object
required

Pagination metadata for the business email list. Total count is not available.