Alerts API Reference

This page describes types of data available in the Alerts API

The Alerts API provides two top-level nodes for Craft API: alerts and alert.

Alerts node signature

Returns a subset of Alerts as per specified arguments. The default page size is 100 items. Items are sorted by the publishedAt field in descending order by default.

Argument

Type

Description

Default

first

Int

The number of Alerts to retrieve. Should be between 1 and 100 if specified

100

after

ID

When specified, API will return the next page of Alerts after given ID

where

AlertBoolExpression

An expression defining a subset of Alerts to be returned from the API

orderBy

AlertOrderBy

Specifies fields and sorting order for the API output

publishedAt DESC

Alert node signature

Allows retrieving a single Alert by its ID.

Argument

Type

Description

Default

id

ID

Unique ID of Alert, as retrieved from Alerts API