Get channel list

Available in Classic and VPC

Get the channel list.

Request

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

Method	URI
GET	/v1/api/channels

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`filter`	String	Required	Filtering criteria Filters by some fields in the response body. Filters only full matches. Enter an empty value `{}` if there is no criteria. Example: `{"id":"{Channel ID}"}`, `{"name":"{Channel name}"}`, `{"disabled":false}`
`sort`	String	Optional	Sort by Enter in the form of `{Criteria:Method}`. Criteria: String type fields in the response body. Method: `-1` \| `1` `-1`: Descending. `1`: Ascending. e.g., `{"createdAt":"-1"}`: Descending by creation date and time.
`option`	String	Optional	Additional options: Option e.g., `{"offset":0,"per_page":20}`: Display the first 20 items.

Option

The following describes Option.

Field	Type	Required	Description
`offset`	Number	Optional	Query start point 0-N
`per_page`	Number	Optional	Number of items per page 1-100
`count`	Boolean	Optional	Whether to display the number of response results instead of a list `true` \| `false` `true`: Display the response result count. `false`: Display the list.

Request example

The request example is as follows:

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels
?filter=%7B%22type%22%3A%22PUBLIC%22%7D
&sort=%7B%22createdAt%22%3A%22-1%22%7D
&option=%7B%22offset%22%3A0%2C%22per_page%22%3A2%7D' \
--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": "TWVtYmVyczo**********************************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"
    },
    {
        "id": "5169ed4b-****-****-****-2c89ec3dc97e",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "channel_name_test",
        "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
        "user": {
            "id": "TWVtYmVyczp************************************jZDRmZWY0NmU=",
            "name": "Admin",
            "profile": ""
        },
        "unique_id": null,
        "type": "PUBLIC",
        "translation": false,
        "members": [],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 0,
        "link_url": null,
        "image_url": null,
        "created_at": "2025-07-20T00:36:55+09:00",
        "updated_at": "2025-07-20T00:36:55+09:00"
    }
]