Skip to main content
GET
List messages

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Query Parameters

cursor
string
limit
integer
Required range: 1 <= x <= 100
from
string
to
string
status
enum<string>
Available options:
delivered,
bounced,
deferred
recipient
string<email>
campaignId
string<uuid>

Response

success
boolean
required
Example:

true

message
string
required
data
object[]
required
meta
object
required