---
title: "Retrieve a specific notification channel"
method: GET
path: "/v5/notifications/channels/{channelId}"
tags: ["Notifications"]
---

# Retrieve a specific notification channel

`GET /v5/notifications/channels/{channelId}`

## Request

- Base URL: `https://api.kadoa.com`
- URL: `https://api.kadoa.com/v5/notifications/channels/{channelId}`
- Auth: API key in header `x-api-key`

## Path parameters

- `channelId` string, required

## Query parameters

- `includeConfigurations` boolean

## Response `200`

Channel retrieved successfully

- object
  - `data` object
    - `channel` object
      - `id` string
      - `name` string
      - `channelType` string
      - `config` union: Configuration object specific to the channel type
        - object
          - `recipients` string[], required: Array of recipient email addresses
          - `from` string, email: Sender email address (optional, must be a @kadoa.com domain email)
        - object
          - `webhookUrl` string, uri: Slack webhook URL (optional)
          - `slackChannelId` string, required: Slack channel ID
          - `slackChannelName` string, required: Slack channel name
        - object
          - `webhookUrl` string, uri, required: Webhook endpoint URL
          - `httpMethod` 'POST' | 'GET' | 'PUT' | 'PATCH', required: HTTP method for the webhook
          - `auth` object: Authentication configuration (optional)
            - `type` 'bearer' | 'basic' | 'header': Authentication type
            - `token` string: Bearer token (for bearer auth)
            - `username` string: Username (for basic auth)
            - `password` string: Password (for basic auth)
            - `headers` object: Additional headers (for header auth)
        - object: WebSocket channel configuration. Note - Only one WebSocket channel is allowed per workspace. Leave empty object {} as no configuration is needed.
      - `linkedConfigurations` object[]: List of notification configurations linked to this channel
        - `configurationId` string: The configuration ID
        - `workflowId` string, nullable: Workflow ID if this is a workflow-specific configuration, null for workspace-level configurations
        - `eventType` string: Event type for this configuration (e.g., workflow_sample_finished, workflow_data_change)
        - `enabled` boolean: Whether this configuration is enabled
      - `createdAt` string
      - `updatedAt` string
  - `status` string
  - `message` string

## Other responses

- `401`: Unauthorized
- `404`: Channel not found
- `500`: Internal server error

---

[API](https://skmtc.dev/kadoa/apis/kadoa-api.md) · [All operations](https://skmtc.dev/kadoa/apis/kadoa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kadoa/apis/kadoa-api/revisions/bf7803c927b4?raw)
