List Notification Channels

GET /api/notification-channels

Query ParametersCopy Anchor Link

Example (cURL)Copy Anchor Link

curl -X GET "$BASE_URL/api/notification-channels?organizationId=1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

ResponseCopy Anchor Link

[
  {
    "id": 1,
    "organizationId": 1,
    "customerId": null,
    "websiteId": null,
    "type": "email",
    "category": "direct",
    "name": "Ops Email",
    "config": { "email": "ops@deinkunde.com", "to": "Ops Team" },
    "delaySeconds": 0,
    "conditions": null,
    "isActive": true,
    "allowedPackageTypes": null
  },
  {
    "id": 2,
    "organizationId": 1,
    "customerId": null,
    "websiteId": null,
    "type": "slack",
    "category": "integration",
    "name": "Alerts Slack Channel",
    "config": { "webhookUrl": null, "hasWebhookUrl": true, "username": "Uptimeify" },
    "delaySeconds": 0,
    "conditions": null,
    "isActive": true,
    "allowedPackageTypes": null
  }
]

Secrets inside config are never returned: a Slack, Discord or Teams webhook URL comes back as null with hasWebhookUrl: true next to it, see "Channel Types and Config" on the Notification Channels overview page.

VisibilityCopy Anchor Link

Without websiteId and without customerId, which channels come back depends on who is reading:

• An unrestricted reader (organization admin, global admin, and an organization-bound agent token) receives the organization-level channels, that is those with customerId: null and websiteId: null.
• A customer-scoped reader (a readonly user or an editor with explicit customer assignments, plus the API or agent token minted for such a user) receives the channels of their own customers in addition to the organization-level ones. Channels of another customer are never returned.

Naming customerId returns that customer's channels plus the organization-level ones. Naming websiteId additionally returns the website's own override channels.

Common errorsCopy Anchor Link

• 401 Unauthorized when not authenticated
• 403 Forbidden when accessing channels outside your scope