Skip to main content
GET
List notifications

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

brandAgentId
number
campaignId
string
creativeId
string
status
enum<string>
Available options:
success,
error,
warning,
info
types
string
unreadOnly
enum<string>
Available options:
true,
false
limit
number
Required range: 1 <= x <= 100
offset
number
Required range: x >= 0

Response

List notifications

Paginated list of notification summaries (storefront spec)

notifications
object[]
required

Notifications projected to the summary shape. Use the notification detail endpoint for the full data payload.

totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
unreadCount
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required