Skip to main content

Channel object

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

A channel object is a legacy object that contains information about a workspace channel. These channel objects are not the same object type as private channels, which are considered group objects. Channels and groups are now considered a type of conversation.

FieldTypeDescription
idstringThe channel ID.
namestringIndicates the name of the channel-like thing, without a leading hash sign. Don't get too attached to that name. It might change. Don't even bother storing it. When thinking about channel-like things, think about their IDs, their type, and the team/workspace they belong to.
is_channelbooleanIndicates if it is a channel.
createdUnix timestampTimestamp of when the channel was created.
creatorstringThe user ID of the member that created the channel.
is_archivedbooleantrue if the channel is archived.
is_generalbooleantrue if this channel is the "general" channel that includes all regular members. In most workspaces this is called #general, but some workspaces have renamed it.
name_normalizedstringA normalized string of the name.
is_sharedbooleantrue if the channel is shared.
is_org_sharedbooleanIndicates if the organization which the channel belongs to is shared.
is_memberbooleantrue if the calling member is part of the channel.
is_privatebooleanIndicates if the channel is private.
is_mpimbooleanIndicates if the channel is a multi-party instant message.
last_readUnix timestampThe timestamp for the last message the calling user has read in this channel.
latestobjectThe latest message in the channel.
unread_countintegerA full count of visible messages that the calling user has yet to read.
unread_count_displayintegerA count of messages that the calling user has yet to read that matter to them (this means it excludes things like join/leave messages).
membersarrayA list of user IDs for all users in this channel. This includes any disabled accounts that were in this channel when they were disabled.
topicobjectThe topic of the channel.
purposeobjectThe purpose of the channel.
previous_namesarrayA list of prior names the channel has used.
{
"ok": true,
"channel": {
"id": "C1H9RESGL",
"name": "busting",
"is_channel": true,
"created": 1466025154,
"creator": "U0G9QF9C6",
"is_archived": false,
"is_general": false,
"name_normalized": "busting",
"is_shared": false,
"is_org_shared": false,
"is_member": true,
"is_private": false,
"is_mpim": false,
"last_read": "1503435939.000101",
"latest": {
"text": "Containment unit is 98% full",
"username": "ecto1138",
"bot_id": "B19LU7CSY",
"attachments": [
{
"text": "Don't get too attached",
"id": 1,
"fallback": "This is an attachment fallback"
}
],
"type": "message",
"subtype": "bot_message",
"ts": "1503435956.000247"
},
"unread_count": 1,
"unread_count_display": 1,
"members": [
"U0G9QF9C6",
"U1QNSQB9U"
],
"topic": {
"value": "Spiritual containment strategies",
"creator": "U0G9QF9C6",
"last_set": 1503435128
},
"purpose": {
"value": "Discuss busting ghosts",
"creator": "U0G9QF9C6",
"last_set": 1503435128
},
"previous_names": [
"dusting"
]
}
}