Details of Response Fields

Find the details of some repeated response fields.

We'll cover the following

Many response objects from the Slack API include properties repeated across several other responses. Let’s look at some of these properties and the details of the objects they contain.

Note: Depending on the endpoint we call, the response may or may not include several of the fields discussed for each object.

Messages

Many responses include a message property containing the details of a specific message posted to a conversation. Some of the more important properties of the message object are discussed in the table below:

Property

Type

Description

type

string

The type of message that was posted.

subtype

string

The subtype of the message, indicating whether it was a "me" message, within a thread, etc.

text

string

The message text that is displayed within notifications.

user

string

The ID of the user that posted the message.

bot_id

string

The ID of the bot that posted the message.

app_id

string

The ID of the application that posted the message.

ts

string

The timestamp of the posted message.

thread_ts

string

The timestamp of the posted message if it was posted within a thread.

edited

object

An object containing the ID of the user that edited the message and the timestamp of when the message was edited.

blocks

array[object]

An array of message blocks.

attachments

array[object]

An array of attachments to the message, if any.

reactions

array[object]

An array of all reactions added to the message, including the reaction name and the users that added the reaction.

Channels

A channel field is often included in responses dealing with conversation management. Here are the details of some of the more important properties of the channel object:

Property

Type

Description

id

string

The unique ID of the conversation.

name

string

The name of the conversation.

is_channel

boolean

Indicates whether the conversation is a public channel.

is_group

boolean

Indicates whether the conversation is a private group chat.

is_mpim

boolean

Indicates whether the conversation is a multiparty group message.

is_im

boolean

Indicates whether the conversation is a private message.

is_private

boolean

Indicates whether the conversation is private.

created

string

The Unix timestamp of when the conversation was created.

creator

string

The ID of the user that created the conversation.

topic

object

The details of the conversation topic, including the value of the topic, when it was set, and the user that set the topic.

purpose

object

The details of the conversation purpose, including the value of the purpose, when it was set, and the user that set the purpose.

previous_names

array[string]

A list of the conversation's previous names.

Files

The file field is included in responses dealing with file management. Some of the more important properties of the file object are discussed in the table below:

Property

Type

Description

id

string

The unique ID of the file.

created

number

The timestamp of when the file was created.

name

string

The full name of the file, including the file extension.

title

string

The title of the file.

filetype

string

The file type.

user

string

The ID of the user who created the file.

size

number

The file size in bytes.

is_external

boolean

Indicates whether the file is an external/remote file.

is_public

boolean

Indicates whether the file is shared publicly.

preview

string

The preview that is shown when the file is shared within a conversation.

Users

The member field is included in responses dealing with user management. Some of the more important properties of the member object are discussed in the table below:

Property

Type

Description

id

string

The unique ID of the user.

name

string

The user's full name.

deleted

boolean

Indicates whether the user has been deleted.

tz

string

The user's timezone.

profile

object

The user's profile, including social media links, contact information, name details, and status.

is_admin

boolean

Indicates whether the user has administrator permissions.

is_owner

boolean

Indicates whether the user is the owner of the workspace.

is_bot

boolean

Indicates whether the user is a bot.