Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Query Parameters

limit
integer
Required range: 1 <= x <= 100
cursor
string
q
string
Maximum string length: 200
status
enum<string>
Available options:
queued,
processing,
completed,
scheduled,
canceled
channel
enum<string>
Available options:
push,
email
topic
string
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
from
string<date-time>
to
string<date-time>

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required