List channels

Lists a realm’s channels (realm_id), or an organization’s (org_id, or account: true), optionally only enabled ones or matching query.

Requires a signed-in user token; with realm_id, a realm member (or higher) on that realm; with org_id, membership in that organization. With neither, the results are limited to what you can see.

POST /v1/notification_channels/get

cURL

realm

curl --request POST \ --url https://{host}/v1/notification_channels/get \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b" } '

200

{
  "ok": true,
  "data": [
    {
      "id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b",
      "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
      "org_id": null,
      "user_id": null,
      "name": "ops-slack",
      "destinations": [
        {
          "type": "slack",
          "webhook_url": "https://hooks.slack.com/services/T000/B000/XXXX"
        }
      ],
      "enabled": true,
      "created_at": 1759000000000,
      "updated_at": 1759000000000,
      "rule_count": 1,
      "system_key": null,
      "locked": false,
      "lock_reason": null
    }
  ]
}

Authorizations

Authorization · string · header · required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

org_id · string<uuid>

Organization this call targets. Required for account-scoped channel/rule ops and inbox.

realm_id · string

Realm to list channels for; omit (or set account) for org/account channels

Minimum string length: 1

account · boolean

When true, list account-owned channels (realm_id must be null/omitted)

enabled · boolean

When true, only return enabled channels

ids · string[]

Optional id set; with enabled=true, resolves those ids then filters to the realm

query · string

Substring match on channel name

Response

200

application/json

Success.

ok · enum<boolean> · required

Always true on success.

Available options: true

data · object[] · required

Show child attributes