Get channel

Prev Next

Available in Classic and VPC

Get channel details.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /v1/api/channels/{channelId}

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
channelId String Required Channel ID

Request example

The request example is as follows:

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/ef14cd79-****-****-****-3efc52465f08' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Channel ID
project_id String - Project ID
name String - Channel name
user_id String - Channel creator ID
user Object - Creator information
user.id String - Channel creator ID
user.name String - Creator name
user.profile String - Creator profile image
unique_id String - Channel unique ID
  • ID that the user enters for unique identification purposes
type String - Channel type
  • PUBLIC | PRIVATE
    • PUBLIC: Public
    • PRIVATE: Private
translation Boolean - Automatic translation
  • true | false
    • true: Translate
    • false: Not translate
members Array - List of subscribable user IDs
  • Display valid value if type is PRIVATE.
disabled Boolean - Whether it is disabled
  • true | false
    • true: Disabled
    • false: Enabled
mutes Boolean - Whether to mute
  • true | false
    • true: Mute
    • false: Not mute
push Boolean - Whether to allow push notifications
  • true | false
    • true: Allow
    • false: Block
limit Integer - Maximum number of participants
  • 0: Unlimited
link_url String - Channel link URL
image_url Array - Channel image URL
created_at String - Channel creation date and time
  • ISO 8601 format
updated_at String - Information modification date and time
  • ISO 8601 format

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

{
    "id": "ef14cd79-****-****-****-3efc52465f08",
    "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
    "name": "channel_apitester",
    "user_id": "39c8de0f-****-****-****-6a1a875df59f",
    "user": {
        "id": "TWVtYmVycz****************************************ODc1ZGY1OWY=",
        "name": "apitester",
        "profile": ""
    },
    "unique_id": "apitester123",
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": true,
    "limit": 0,
    "link_url": null,
    "image_url": null,
    "created_at": "2025-07-23T13:52:52+09:00",
    "updated_at": "2025-07-23T14:03:20+09:00"
}