List notification configurations

GET

https://api.modulards.com/api/public/v1/alerts

GET

/api/public/v1/alerts

curl https://api.modulards.com/api/public/v1/alerts \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "attributes": {
        "sites_count": 4
      },
      "id": "12",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/alerts/12"
      },
      "relationships": {
        "contacts": {
          "data": [
            {
              "id": "7",
              "type": "contacts"
            }
          ]
        },
        "integrations": {
          "data": [
            {
              "id": "9",
              "type": "alert-integrations"
            }
          ]
        },
        "items": {
          "data": [
            {
              "id": "301",
              "type": "alert-items"
            }
          ]
        }
      },
      "type": "alerts"
    }
  ],
  "included": [
    {
      "attributes": {
        "status": "enabled",
        "type": "uptime.down"
      },
      "id": "301",
      "type": "alert-items"
    },
    {
      "attributes": {
        "created_at": "2026-09-18T10:00:00.000000Z",
        "type": "slack",
        "updated_at": "2026-09-18T10:00:00.000000Z",
        "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
      },
      "id": "9",
      "type": "alert-integrations"
    },
    {
      "attributes": {
        "company": null,
        "created_at": "2026-08-01T09:00:00.000000Z",
        "last_name": "Doe",
        "name": "Alice",
        "updated_at": "2026-08-01T09:00:00.000000Z"
      },
      "id": "7",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/contacts/7"
      },
      "type": "contacts"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "https://api.modulards.com/api/public/v1/alerts?page%5Bnumber%5D=1",
    "last": "https://api.modulards.com/api/public/v1/alerts?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "page": null,
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "page": 1,
        "url": "https://api.modulards.com/api/public/v1/alerts?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "page": null,
        "url": null
      }
    ],
    "path": "https://api.modulards.com/api/public/v1/alerts",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Lists the notification configurations you can reach. Use it to see which events are watched and how you are notified, or to find the configurations that cover a website or an event, for example filter[type][]=uptime.down.

By default the newest come first. Add the event settings, the Slack and Discord destinations and the contacts of each configuration to the answer with include. Websites are not included: list them with “List websites” and filter[alerts][].

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

page[number]stringOptional

Page number, starting at 1.

page[size]stringOptional

Rows per page, up to 50 (default 15).

sortstringOptional

Sort order. Accepted: name (case-insensitive), created_at, updated_at, sites_count; a leading - reverses the order. Default -created_at, the newest first.

filter[is_default]stringOptional

1 for only the default configuration, 0 for only the others.

filter[status][]stringOptional

Only configurations with these statuses: enabled or disabled. Several values match any of them.

filter[sites][]stringOptional

Only the configurations that cover these websites, by website id. A configuration matches when it covers any of them.

filter[type][]stringOptional

Only the configurations that have these events enabled, for example uptime.down. Several values match any of them.

filter[s]stringOptional

Free-text search over the configuration name.

includestringOptional

Related data to return with each configuration. Accepted: items (the event settings), integrations (the Slack and Discord destinations, with their complete URL) and contacts. Separate several with commas.

fields[alerts]stringOptional

Name sites_count to get the number of websites of each configuration that your token can reach.

filter[id][]stringOptional

Only these configurations, by id. Several ids match any of them.

Response

200 - Configurations

datalist of objectsOptional

includedlist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error