Skip to main content
List alert topics

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as agreement.id. id is always returned. Fields: id, agreement, title, description, is_locked, counts, organization_currency, created_at, updated_at.

limit
integer
default:50

Maximum number of results per page.

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

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
agreement_ids
string

Comma-separated, at most 50 values.

Required string length: 1 - 200
has_alert_statuses
string

Topics with an alert in any of these derived display statuses: pending, claimed, dismissed, credited. A credit takes precedence over the verdict.

include_empty
enum<string>
default:false

Include topics without live alerts, such as a new topic or one whose alerts were moved out.

Available options:
true,
false
sort
enum<string>
default:created_at

open_alert_impact is the impact of the open (pending and claimed, uncredited) alerts in the organization currency, to rank topics by money at stake.

Available options:
created_at,
title,
open_alert_impact
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of topics.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required