Skip to main content
GET
List messages
Requires the IAM action notifications:ListMessages on the topic. See Notifications permissions.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

topic_id
string<uuid>
required
Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Query Parameters

crn
string

Exact message CRN. Foreign identities return an empty page; malformed CRNs are invalid.

Example:

"crn:notifications:sa-saopaulo-1:acme:message/019400aa-bbbb-7ccc-8ddd-eeeeffff0000"

fanout_state
enum<string>
Available options:
pending,
complete
Example:

"complete"

marker
string<uuid>

Id of the last item on the previous page.

Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

limit
integer
default:50

Maximum items to return. A larger value is clamped to the maximum rather than rejected, so page until meta.has_more is false.

Required range: 1 <= x <= 200
Example:

50

Response

Paginated list of message metadata.

messages
object[]
required
meta
object
required