Skip to content
The Desk

Show a channel

GET
/channels/{channel}
curl --request GET \
  --url https://desk.example.com/api/v1/channels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Required scope: channels:read

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
channel
required
string format: uuid

The channel’s id.

Responses

Section titled “Responses”

200

Section titled “200”

The channel.

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
slug
required
string
visibility
required

Whether the channel is open to the whole team or invite-only.

string
Allowed values: public private
topic
required
string | null
is_general
required

Whether this is the workspace’s default channel.

boolean
is_archived
required
boolean
is_direct
required

Whether this is a direct-message conversation.

boolean
created_at
required
string | null format: date-time
Example
{
  "data": {
    "visibility": "public"
  }
}

401

Section titled “401”

The token is missing, malformed, or revoked.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

The token lacks the scope this operation requires, or its subject may see the resource but not perform this action on it.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

The resource does not exist, is outside the token’s workspace, or the integrations platform is disabled. A channel the subject cannot see is reported here rather than as a 403, so the API never leaks its existence.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

The per-token rate limit (INTEGRATIONS_API_RATE_LIMIT requests per minute) was exceeded. Retry after the Retry-After header.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.