alerts

List Alerts

Return the alerts visible to the token owner, newest first. Send no paging parameters and you getthe whole visible set, unchanged. Sendpage orper_page to page through it — up to 500 per page — and the response additionally carries apage block alongsidedata with currentPage, nextPage, lastPage, perPage and totalItems.

get/alerts

Request

Query parameters

pageinteger
per_pageinteger

Response

Successful Response

messagestring
dataobject[]
pageobject

Example response

{
  "message": "Success",
  "data": [
    {
      "id": 84,
      "type": "site.backup_completed",
      "category": "completed",
      "severity": "info",
      "title": "On-demand backup saved",
      "message": "An on-demand backup of example-site finished.",
      "site": {
        "id": 2,
        "name": "example-site",
        "display_name": "Example Site"
      },
      "icon": "fa-rotate",
      "actions": [
        {
          "label": "View Backups",
          "url": "/sites/2/backups_restores#site-ondemand-backups",
          "style": "primary"
        }
      ],
      "read": false,
      "dismissed": false,
      "created_at": "2026-06-23T18:00:00.000Z"
    }
  ],
  "page": {
    "currentPage": 1,
    "nextPage": 2,
    "lastPage": 3,
    "perPage": 500,
    "totalItems": 1132
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.