Skip to main content
GET
List alerts
Related guide: Alerts guide. See the Alerts guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>

Page size, 1-200. Unset uses the server default (25).

starting_after
string

Cursor for forward pagination. Set to the alert_id of the last item from the previous page.

ending_before
string

Cursor for backward pagination. Set to the alert_id of the first item from the previous page.

project_id
string

Restrict results to one project.

scope
enum<string>

Restrict results by ownership boundary. Unspecified returns all alerts visible to the caller; non-admin callers never see workspace alerts.

Available options:
ALERT_SCOPE_PROJECT,
ALERT_SCOPE_WORKSPACE

Response

OK

object
string
required

Object discriminator for list responses; always list.

data
object[]
required

Page of alerts, ordered newest first.

has_more
boolean
required

Whether more alerts are available in the selected pagination direction.