Retrieve information about a conversation.
Information about required scopes
This Conversations API method's required scopes depend on the type of channel-like object you're working with. You only need the scopes corresponding to that conversation type, found below in Required scopes.
GEThttps://slack.com/api/conversations.infoapplication/x-www-form-urlencodedtokenAuthentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxxThis Conversations API method returns information about a workspace conversation.
Returns a conversation object, which could be a public channel, private channel, direct message, multi-person direct message, depending completely on the channel ID and the permissions granted to your token.
Some fields in the response, like unread_count and unread_count_display, are included for DM conversations only.
Typical success response for a public channel. A response from a private channel and a multi-party IM is very similar to this example. Note that if the properties.tabs parameter is an empty set, it will not be included in the channel object.
{
"ok": true,
"channel": {
"id": "C012AB3CD",
"name": "general",
"is_channel": true,
"is_group": false,
"is_im": false,
"is_mpim": false,
"is_private": false,
"created": 1654868334,
"is_archived": false,
"is_general": true,
"unlinked": 0,
"name_normalized": "general",
"is_shared": false,
"is_frozen": false,
"is_org_shared": false,
"is_pending_ext_shared": false,
"pending_shared": [],
"context_team_id": "T123ABC456",
"updated": 1723130875818,
"parent_conversation": null,
"creator": "U123ABC456",
"is_ext_shared": false,
"shared_team_ids": [
"T123ABC456"
],
"pending_connected_team_ids": [],
"topic": {
"value": "For public discussion of generalities",
"creator": "W012A3BCD",
"last_set": 1449709364
},
"purpose": {
"value": "This part of the workspace is for fun. Make fun here.",
"creator": "W012A3BCD",
"last_set": 1449709364
},
"properties": {
"tabs": [
{
"id": "workflows",
"label": "",
"type": "workflows"
},
{
"id": "files",
"label": "",
"type": "files"
},
{
"id": "bookmarks",
"label": "",
"type": "bookmarks"
}
]
},
"previous_names": []
}
}Typical success response for a 1:1 direct message
{
"ok": true,
"channel": {
"id": "C012AB3CD",
"created": 1507235627,
"is_im": true,
"is_org_shared": false,
"user": "U27FFLNF4",
"last_read": "1513718191.000038",
"latest": {
"type": "message",
"user": "U5R3PALPN",
"text": "Psssst!",
"ts": "1513718191.000038"
},
"unread_count": 0,
"unread_count_display": 0,
"is_open": true,
"locale": "en-US",
"priority": 0.043016851216706
}
}When using the method with the include_num_members parameter, we return a num_members field
{
"ok": true,
"channel": {
"id": "C012AB3CD",
"created": 1507235627,
"is_im": true,
"is_org_shared": false,
"user": "U27FFLNF4",
"last_read": "1513718191.000038",
"latest": {
"type": "message",
"user": "U5R3PALPN",
"text": "Psssst!",
"ts": "1513718191.000038"
},
"unread_count": 0,
"unread_count_display": 0,
"is_open": true,
"locale": "en-US",
"priority": 0.043016851216706,
"num_members": 2
}
}Typical error response when a channel cannot be found
{
"ok": false,
"error": "channel_not_found"
} This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.
| Error | Description |
|---|---|
channel_not_found | Value passed for |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
deprecated_endpoint | The endpoint has been deprecated. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
method_deprecated | The method has been deprecated. |
not_allowed_token_type | The token type used in this request is not allowed. |
not_authed | No authentication token provided. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
token_expired | Authentication token has expired |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
two_factor_setup_required | Two factor setup is required. |
accesslimited | Access to this method is limited on the current network |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
| Warning | Description |
|---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |