Get Alerts

Required Permissions

applications:read

Rate Limit

basic

Query Params
string

Unique identifier for the application this alert is associated with.

string

Unique identifier for the contract this alert is associated with.

string

Unique identifier for an alert.

string

Date and time the alert was last processed by the system.

string

The alert memo. This is additional information included in the alert notification.

string
enum

Alert delivery method. There are three methods for delivery; email, slack, and teams. Email is configured to work out of the box but the other two require additional setup.

Allowed:
string

Email address of the Owner. The email must belong to a user in the Zylo system.

string
enum

Type of alert. There are three types of alerts; contract-renewal, renewal, and transaction.

Allowed:
string

Date and time the record was created in Zylo.

string

Date and time the record was last modified in Zylo. Uses the created date by default.

string
Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

double
≤ 1000
Defaults to 50

Number of results to bring back.

double
Defaults to 0

Offset the results by this number.

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

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