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.

Path Parameters

project_id
string
required

The unique identifier of the project whose alerts are listed

Query Parameters

page
integer
default:1

1-indexed page number

Required range: x >= 1
limit
integer
default:20

Number of alerts to return per page

Required range: 1 <= x <= 100
status
enum<string>

Only return alerts in this status

Available options:
ACTIVE,
TRIGGERED,
PAUSED,
RESOLVED
sort_by
enum<string>
default:created_at

Field to sort results by

Available options:
created_at,
updated_at,
name,
status,
frequency,
last_triggered
sort_order
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Alerts retrieved successfully

A paginated list of alerts

success
enum<boolean>
required
Available options:
true
data
object[]
required
pagination
object
required