List Alerts

Returns a list of alerts associated with a contact. A contact may have many alerts. To retrieve alerts for all contacts, use contacts/- in the URL parameter. Only alerts that are currently active are returned unless show_inactive is set.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The contact id.

Query Params
int32
1 to 1000

The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

A page token, received from a previous ListAlerts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAlerts must match the call that provided the page token.

string

Fields to order the results by, following AIP-132 ordering syntax.

string

Filter parameter for narrowing the result set. See https://aip.kolla.dev/160 for more info.

boolean

Whether to include alerts that are no longer in effect. Defaults to false, so that only currently active alerts are returned.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json