List configurations | Modular DS

{
  "data": [
    {
      "attributes": {
        "created_at": "2026-09-20T09:00:00.000000Z",
        "discord_channel": false,
        "email_channel": true,
        "is_default": true,
        "name": "Operations",
        "sites_count": 4,
        "slack_channel": true,
        "status": "enabled",
        "updated_at": "2026-09-20T09:00:00.000000Z",
        "whatsapp_channel": false
      },
      "id": "12",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/alerts/12"
      },
      "type": "alerts"
    }
  ],
  "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",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "https://api.modulards.com/api/public/v1/alerts?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "https://api.modulards.com/api/public/v1/alerts",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Lists the notification configurations the token can reach, one JSON:API resource per configuration, with standard pagination.\n\nPublic filters: id[] (exact configuration ids), s (free-text search on name), status[] (enabled|disabled), is_default (1/0), sites[] (exact website ids - a configuration matches when associated with any of them) and type[] (alerting event types, e.g. uptime.down - only configurations with that event enabled match).\n\nPublic sorts: name (case-insensitive), created_at (default, descending), updated_at and sites_count - prefix with - for descending.\n\nPublic includes: items (alert-items, the event settings), integrations (alert-integrations, the Slack/Discord destinations, complete url) and contacts (the Contacts it notifies). Websites are not included here: list them with “List sites” and filter[alerts][].\n\nfields[alerts]=sites_count opts a bare listing into the computed, reachable website count.\n\nDefault page size is 15, capped at 50 (page[size]).

Lists the notification configurations the token can reach, one JSON:API resource per configuration, with standard pagination.\n\nPublic filters: `id[]` (exact configuration ids), `s` (free-text search on `name`), `status[]` (`enabled`|`disabled`), `is_default` (`1`/`0`), `sites[]` (exact website ids - a configuration matches when associated with any of them) and `type[]` (alerting event types, e.g. `uptime.down` - only configurations with that event enabled match).\n\nPublic sorts: `name` (case-insensitive), `created_at` (default, descending), `updated_at` and `sites_count` - prefix with `-` for descending.\n\nPublic includes: `items` (`alert-items`, the event settings), `integrations` (`alert-integrations`, the Slack/Discord destinations, complete `url`) and `contacts` (the Contacts it notifies). Websites are not included here: list them with \"List sites\" and `filter[alerts][]`.\n\n`fields[alerts]=sites_count` opts a bare listing into the computed, reachable website count.\n\nDefault page size is 15, capped at 50 (`page[size]`).

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[size]stringOptional

Max 50, default 15

sortstringOptional

name | created_at (default, descending) | updated_at | sites_count, --prefixed for descending

filter[is_default]stringOptional

1|0

filter[status][]stringOptional

enabled | disabled

filter[sites][]stringOptional

Exact website ids; a configuration matches when associated with any of them

filter[type][]stringOptional

Alerting event type; only configurations with that event enabled match

filter[s]stringOptional

Free-text search on name

includestringOptional

items | integrations | contacts

fields[alerts]stringOptional

Opts a bare listing into the reachable website count

Response

200 - Configurations

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error