Skip to Content
API keys are issued to organizations with a signed BAA. Request API access →
API referenceList broadcast messages

List broadcast messages

GET/broadcasts/{broadcastId}/messages

Lists the messages sent by a broadcast.

Scope broadcasts:read

Path parameters

broadcastIdUUIDRequired

ID of the broadcast.

Query parameters

page[limit]integer

Number of records to return. Defaults to 50, maximum 100.

page[after]string

Cursor from the previous page’s pagination.next_cursor.

Returns

Returns 200 OK with a data array of Message objects and a pagination object. See pagination.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

StatusCodeMeaning
400invalid_requestThe request is malformed, such as invalid JSON.
401unauthorizedThe API key is missing, revoked, or invalid.
403insufficient_scopeThe key lacks the required scope.
404not_foundThe resource doesn’t exist or isn’t visible to this key.
429rate_limitedToo many requests. Retry after Retry-After seconds.
Last updated on