Skip to main content
GET
Retrieve Channel

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

dms:read
chat:read
support_chat:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Public resource ID.

Svar

operation completed

account_id
string | null
påkrævet
Eksempel:

"biz_xxxxxxxxxxxxxx"

created_at
string
påkrævet

Creation time as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

deleted_at
string | null
påkrævet

When the channel was deleted or removed from your channel list, as an ISO 8601 timestamp. Null for a live channel.

Eksempel:

null

experience_id
string | null
påkrævet
Eksempel:

null

icon
object | null
påkrævet

The channel icon. Community channels show the experience logo, falling back to the app icon. Support channels show the account logo. Group private channels show their own icon. Null for one-to-one private channels or when no image is set.

id
string
påkrævet

Existing public channel ID, preserved across REST and chat clients.

Eksempel:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

kind
enum<string>
påkrævet
Tilgængelige muligheder:
private,
community,
support
Eksempel:

"private"

last_message_at
string | null
påkrævet

When the channel last recorded message activity, as an ISO 8601 timestamp. Null when no message activity is recorded.

Eksempel:

"2026-01-01T12:00:00.000Z"

last_message_id
string | null
påkrævet
Eksempel:

"post_xxxxxxxxxxxxxxxxxxxxxx"

membership
object | null
påkrævet
moderation
object | null
påkrævet
name
string | null
påkrævet
Eksempel:

"Renamed"

notifications_enabled
boolean
påkrævet

Whether app notifications are on. Webhooks fire either way.

Eksempel:

true

support
object | null
påkrævet
updated_at
string
påkrævet

Last channel change as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"