Skip to main content
GET
/
v5
/
notifications
/
channels
/
{channelId}
Retrieve a specific notification channel
curl --request GET \
  --url https://api.kadoa.com/v5/notifications/channels/{channelId} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "channel": {
      "id": "<string>",
      "name": "<string>",
      "channelType": "<string>",
      "config": {
        "recipients": [
          "user@example.com",
          "admin@company.com"
        ],
        "from": "notifications@kadoa.com"
      },
      "linkedConfigurations": [
        {
          "configurationId": "<string>",
          "workflowId": "<string>",
          "eventType": "<string>",
          "enabled": true
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  },
  "status": "<string>",
  "message": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
channelId
string
required

Channel ID

Query Parameters

​
includeConfigurations
boolean
default:true

Include linked notification configurations with workflow information

Response

Channel retrieved successfully

​
data
object
​
status
string
​
message
string