Skip to main content
GET
List Alerts

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

Items per page

Required range: 1 <= x <= 200
page
integer
default:0

0-based page index

Required range: 0 <= x <= 10000
search_query
string | null

Case-insensitive substring match on the alert name

Maximum string length: 200
project_id
string | null

Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

Response

Successful Response

Paginated list of the project's alerts for the public API.

data
AlertSummary · object[]
required
meta
AlertListMeta · object
required

Pagination plus the project's alert capacity.