---
title: "Get all notification channels layout"
method: GET
path: "/api/v1/layout/notificationChannels"
tags: ["Notification Channels"]
---

# Get all notification channels layout

`GET /api/v1/layout/notificationChannels`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/layout/notificationChannels`
- Auth: none declared

Gets complete layout of notification channels.

## Response `200`

Retrieved layout of all notification channels.

- DeclarativeNotificationChannels: Notification channels.
  - `notificationChannels` DeclarativeNotificationChannel[], required
    - `allowedRecipients` 'CREATOR' | 'INTERNAL' | 'EXTERNAL': Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
    - `customDashboardUrl` string: Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
    - `dashboardLinkVisibility` 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL': Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
    - `description` string: Description of a notification channel.
    - `destination` union
      - object: Webhook destination for notifications. The property url is required on create and update.
        - `hasSecretKey` boolean, nullable: Flag indicating if webhook has a hmac secret key.
        - `hasToken` boolean, nullable: Flag indicating if webhook has a token.
        - `secretKey` string, nullable: Hmac secret key for the webhook signature.
        - `token` string, nullable: Bearer token for the webhook.
        - `type` 'WEBHOOK', required: The destination type.
        - `url` string: The webhook URL.
      - object: Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
        - `fromEmail` string, email: E-mail address to send notifications from.
        - `fromEmailName` string: An optional e-mail name to send notifications from.
        - `host` string: The SMTP server address.
        - `password` string: The SMTP server password.
        - `port` 25 | 465 | 587 | 2525: The SMTP server port.
        - `type` 'SMTP', required: The destination type.
        - `username` string: The SMTP server username.
      - object: Default SMTP destination for notifications.
        - `fromEmail` string, email: E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.
        - `fromEmailName` string: An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.
        - `type` 'DEFAULT_SMTP', required: The destination type.
      - object: In-platform destination for notifications.
        - `type` 'IN_PLATFORM', required: The destination type.
    - `destinationType` 'WEBHOOK' | 'SMTP' | 'DEFAULT_SMTP' | 'IN_PLATFORM', nullable
    - `id` string, required: Identifier of a notification channel
    - `inPlatformNotification` 'DISABLED' | 'ENABLED': In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
    - `name` string: Name of a notification channel.
    - `notificationSource` string: Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)