Skip to main content
GET
List message delivery logs

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Query Parameters

status

Keep only these statuses. Omit for every status. Several as a list, or over HTTP as one comma-separated value: ?status=SENT,DELIVERED,READ.

Available options:
PENDING,
SENT,
DELIVERED,
READ,
FAILED
channel

Keep only these channels. Omit for every channel. Several as a list, or over HTTP as one comma-separated value: ?channel=WHATSAPP,SMS.

Available options:
WHATSAPP,
EMAIL,
SMS,
VOICE,
WEB_CHAT,
WEB_WIDGET,
FACEBOOK_MESSENGER,
INSTAGRAM
direction
enum<string>
default:OUTBOUND

Defaults to OUTBOUND — a delivery status only means something for a message you sent. Pass INBOUND for what customers sent you.

Available options:
INBOUND,
OUTBOUND
createdAfter
string

Only messages created at or after this moment. A date (2026-08-01) or a full ISO 8601 timestamp.

createdBefore
string

Only messages created at or before this moment. A date (2026-08-01) or a full ISO 8601 timestamp.

Match the recipient's name, phone or email address. A phone matches in any format.

Maximum string length: 100
limit
integer

Page size, up to 1000.

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

Opaque cursor from a previous page.

Response

Success

range
object
required

The window these rows actually cover. Quote it alongside any count you report — with no dates given the read covers a recent window, not all time.

data
object[]
required
next_cursor
string | null
required