Slack · Schema

Channel

A Slack conversation object representing a channel, direct message, multi-person DM, or group conversation.

BotsChatCollaborationMessagingProductivityT1Team Communication

Properties

Name Type Description
id string The unique identifier for this conversation.
name string The name of the channel (without the leading # sign).
name_normalized string Normalized version of the channel name.
is_channel boolean Whether this is a public channel.
is_group boolean Whether this is a private channel (formerly a group).
is_im boolean Whether this is a direct message.
is_mpim boolean Whether this is a multi-person direct message.
is_private boolean Whether this is a private conversation.
is_archived boolean Whether the channel is archived.
is_general boolean Whether this is the
is_shared boolean Whether the channel is shared with another workspace.
is_ext_shared boolean Whether the channel is shared with an external organization via Slack Connect.
is_org_shared boolean Whether the channel is shared across an Enterprise Grid org.
is_pending_ext_shared boolean Whether there is a pending external share invitation.
is_member boolean Whether the calling user is a member of this conversation.
is_open boolean Whether the DM is open.
is_frozen boolean Whether the channel is frozen.
created integer Unix timestamp of when the conversation was created.
creator string User ID of the member who created this channel.
updated integer Unix timestamp of the last update to the conversation.
unlinked integer Number of times the channel has been unlinked.
topic object The channel topic.
purpose object The channel purpose.
previous_names array A list of previous names the channel had.
num_members integer The number of members in the channel. Only included when specifically requested.
locale string IETF language code for the channel locale. Only included when specifically requested.
user string For direct messages, the user ID of the other participant.
shared_team_ids array Array of team IDs that share this channel (for shared channels).
parent_conversation string Parent conversation ID for thread-only channels.
context_team_id string The workspace team ID.
properties object Additional channel properties.
View JSON Schema on GitHub

JSON Schema

slack-web-channel-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Channel",
  "type": "object",
  "description": "A Slack conversation object representing a channel, direct message, multi-person DM, or group conversation.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this conversation."
    },
    "name": {
      "type": "string",
      "description": "The name of the channel (without the leading # sign)."
    },
    "name_normalized": {
      "type": "string",
      "description": "Normalized version of the channel name."
    },
    "is_channel": {
      "type": "boolean",
      "description": "Whether this is a public channel."
    },
    "is_group": {
      "type": "boolean",
      "description": "Whether this is a private channel (formerly a group)."
    },
    "is_im": {
      "type": "boolean",
      "description": "Whether this is a direct message."
    },
    "is_mpim": {
      "type": "boolean",
      "description": "Whether this is a multi-person direct message."
    },
    "is_private": {
      "type": "boolean",
      "description": "Whether this is a private conversation."
    },
    "is_archived": {
      "type": "boolean",
      "description": "Whether the channel is archived."
    },
    "is_general": {
      "type": "boolean",
      "description": "Whether this is the"
    },
    "is_shared": {
      "type": "boolean",
      "description": "Whether the channel is shared with another workspace."
    },
    "is_ext_shared": {
      "type": "boolean",
      "description": "Whether the channel is shared with an external organization via Slack Connect."
    },
    "is_org_shared": {
      "type": "boolean",
      "description": "Whether the channel is shared across an Enterprise Grid org."
    },
    "is_pending_ext_shared": {
      "type": "boolean",
      "description": "Whether there is a pending external share invitation."
    },
    "is_member": {
      "type": "boolean",
      "description": "Whether the calling user is a member of this conversation."
    },
    "is_open": {
      "type": "boolean",
      "description": "Whether the DM is open."
    },
    "is_frozen": {
      "type": "boolean",
      "description": "Whether the channel is frozen."
    },
    "created": {
      "type": "integer",
      "description": "Unix timestamp of when the conversation was created."
    },
    "creator": {
      "type": "string",
      "description": "User ID of the member who created this channel."
    },
    "updated": {
      "type": "integer",
      "description": "Unix timestamp of the last update to the conversation."
    },
    "unlinked": {
      "type": "integer",
      "description": "Number of times the channel has been unlinked."
    },
    "topic": {
      "type": "object",
      "description": "The channel topic."
    },
    "purpose": {
      "type": "object",
      "description": "The channel purpose."
    },
    "previous_names": {
      "type": "array",
      "description": "A list of previous names the channel had."
    },
    "num_members": {
      "type": "integer",
      "description": "The number of members in the channel. Only included when specifically requested."
    },
    "locale": {
      "type": "string",
      "description": "IETF language code for the channel locale. Only included when specifically requested."
    },
    "user": {
      "type": "string",
      "description": "For direct messages, the user ID of the other participant."
    },
    "shared_team_ids": {
      "type": "array",
      "description": "Array of team IDs that share this channel (for shared channels)."
    },
    "parent_conversation": {
      "type": "string",
      "description": "Parent conversation ID for thread-only channels."
    },
    "context_team_id": {
      "type": "string",
      "description": "The workspace team ID."
    },
    "properties": {
      "type": "object",
      "description": "Additional channel properties."
    }
  }
}