Skip to main content
GET
List Alerts

Overview

Returns alerts produced by any of the org’s watches. Alerts are immutable; there’s no PATCH or batch state operation. For polling clients, the recommended pattern is:
  1. Pull pages (newest first) until you reach an id you’ve already processed.
  2. Persist alert IDs in your own store as the system of record for “open work” or “acknowledged.”
Requires the portfolios:manage scope.

Query Parameters

integer
default:"20"
Page size (1-100).
string
Opaque cursor from the previous response.
string
Filter by normal, high, or critical.
string
Filter by trademark.created, trademark.updated, trademark.status_changed, trademark.retracted, or trademark.corrected.
string
default:"all"
all (default) returns alerts from every evaluation revision of a watch; current returns only alerts emitted under each watch’s current query.

Response

string
Always "list".
object[]
Array of Alert objects.
boolean
Whether more pages exist.
object
Cursor envelope.
string
Request identifier.

Errors

Code Examples