---
title: "This endpoint is used for getting a notification channel."
method: GET
path: "/api/v2/notifications/channels/{id}"
tags: ["Notifications Channels"]
---

# This endpoint is used for getting a notification channel.

`GET /api/v2/notifications/channels/{id}`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/notifications/channels/{id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/notifications/channels/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to get a notification channel.

## Path parameters

- `id` string, byte, required

## Response `200`

A successful response.

- JumpcloudNotificationsGetChannelResponse: GetChannelResponse represents the response for getting a channel.
  - `channel` JumpcloudNotificationsChannel: Channel represents the notification channel.
    - `config` JumpcloudNotificationsChannelTypeConfig: ChannelTypeConfig represents the configuration for the channel type.
      - `email` JumpcloudNotificationsEmailRecipientConfig: EmailRecipientConfig represents the email recipient.
        - `role` JumpcloudNotificationsEmailRecipientConfigRole[]
          - `objectId` string, byte: represents the role identifier.
          - `roleObjectId` string, byte: represents the role object identifier.
        - `user` JumpcloudNotificationsEmailRecipientConfigUser[]
          - `address` string: represents the recipient email address.
          - `name` string: represents the recipient name.
          - `objectId` string, byte: represents the address identifier.
      - `slack` JumpcloudNotificationsSlackConfig: SlackConfig represents the slack notification config.
        - `slackChannel` JumpcloudNotificationsSlackChannelConfig[]: represents the slack channel ID where notifications will be sent.
          - `objectId` string, byte
          - `slackChannelId` string: represents the slack channel identifier.
          - `slackTeamId` string: represents the slack team identifier.
          - `slackWorkspaceName` string: represents the slack workspace name.
      - `webhook` JumpcloudNotificationsWebhookConfig: WebhookConfig represents the webhook configuration.
        - `authPassword` string
        - `authToken` string
        - `authType` 'WEBHOOK_AUTH_TYPE_UNSPECIFIED' | 'WEBHOOK_AUTH_TYPE_BASIC' | 'WEBHOOK_AUTH_TYPE_BEARER': WebhookAuthType represents the authentication type for the webhook. - WEBHOOK_AUTH_TYPE_UNSPECIFIED: WEBHOOK_AUTH_TYPE_UNSPECIFIED represents an invalid authentication type. - WEBHOOK_AUTH_TYPE_BASIC: WEBHOOK_AUTH_TYPE_BASIC represents basic authentication. - WEBHOOK_AUTH_TYPE_BEARER: WEBHOOK_AUTH_TYPE_BEARER represents bearer token authentication.
        - `authUsername` string
        - `customHeaders` JumpcloudNotificationsCustomHeaders[]
          - `key` string
          - `masked` boolean
          - `objectId` string, byte
          - `value` string
        - `maskedUrlPortion` JumpcloudNotificationsMaskedURLPortion[]
          - `key` string
          - `objectId` string, byte
          - `value` string
        - `objectId` string, byte: represents the webhook identifier.
        - `sslVerification` boolean
        - `url` string: represents the webhook url.
        - `urlMasked` boolean
    - `createdAt` string, date-time
    - `createdBy` string, byte
    - `description` string: represents the description of the channel.
    - `enabled` boolean: represents the status of the channel.
    - `name` string: represents the name of the channel.
    - `objectId` string, byte: Channel represents a medium through which notifications are sent, such as email notifications.
    - `organizationObjectId` string, byte
    - `type` 'CHANNEL_TYPE_UNSPECIFIED' | 'CHANNEL_TYPE_EMAIL' | 'CHANNEL_TYPE_WEBHOOK' | 'CHANNEL_TYPE_SLACK': ChannelType represents the type of the channel. - CHANNEL_TYPE_UNSPECIFIED: CHANNEL_TYPE_UNSPECIFIED represents an invalid channel type. - CHANNEL_TYPE_EMAIL: CHANNEL_TYPE_EMAIL represents the email channel type. - CHANNEL_TYPE_WEBHOOK: CHANNEL_TYPE_WEBHOOK represents the webhook channel type. - CHANNEL_TYPE_SLACK: CHANNEL_TYPE_SLACK represents the slack channel type.
    - `updatedAt` string, date-time
    - `updatedBy` string, byte

---

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