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

page
number

Page number (1-based)

Example:

1

limit
number

Results per page

Example:

20

status
enum<string>

Filter by status

Available options:
UNREAD,
READ,
ARCHIVED
type
string

Filter by alert type (e.g. deal.status_changed)

Example:

"deal.status_changed"

category
string

Filter by category (e.g. deal, document, compliance)

Example:

"deal"

priority
enum<string>

Filter by priority

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL

Response

Paginated alert list

success
boolean
Example:

true

data
object[]
meta
object