Read configuration

GET

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

GET

/api/public/v1/alerts/:alert_id

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

{
  "data": {
    "attributes": {
      "created_at": "2026-09-20T09:00:00.000000Z",
      "discord_channel": false,
      "email_channel": true,
      "is_default": true,
      "name": "Operations",
      "sites_count": 1,
      "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"
    },
    "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/EXAMPLE/EXAMPLE/EXAMPLE"
      },
      "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",
      "type": "contacts"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  }
}

Single notification configuration (type alerts). Without include, included already carries the event settings (items, alert-items), the Slack/Discord integrations (integrations, alert-integrations, complete url) and the Contacts it notifies (contacts). Passing include= narrows included to only the requested relations - e.g. include=items answers only alert-items. Attributes add sites_count, the reachable website count - there is no sites_selection here, that shape is a dashboard-only concept (the external surfaces add and detach websites explicitly instead of replacing a selection).\n\nA configuration of another organization answers 404.

Single notification configuration (type `alerts`). Without `include`, `included` already carries the event settings (`items`, `alert-items`), the Slack/Discord integrations (`integrations`, `alert-integrations`, complete `url`) and the Contacts it notifies (`contacts`). Passing `include=` narrows `included` to only the requested relations - e.g. `include=items` answers only `alert-items`. Attributes add `sites_count`, the reachable website count - there is no `sites_selection` here, that shape is a dashboard-only concept (the external surfaces add and detach websites explicitly instead of replacing a selection).\n\nA configuration of another organization answers 404.

Authentication

AuthorizationBearer

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

Path parameters

alert_idstringRequired

Query parameters

includestringOptional

Narrows included to only the listed relations (items|integrations|contacts); omit to get all three

Response

200 - Configuration

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional

Errors

404

Not Found Error