conversations_list

GET /conversations.list

Copy endpoint

https://slack.com/api

Lists all channels in a Slack team.

Parameters

query Query Parameters

Name	Type
`token` Authentication token. Requires scope: `conversations:read`	string
`exclude_archived` Set to `true` to exclude archived channels from the list	boolean
`types` Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`	string
`limit` The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.	number
`cursor` Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See pagination for more detail.	string

Responses

200 application/json

Typical success response with only public channels

{ channels:

ObjsConversation

type ObjsConversation = ({
accepted_user?: DefsUserId;
connected_team_ids?: DefsWorkspaceId[];
conversation_host_id?: DefsWorkspaceId;
created: number;
creator: DefsUserId;
display_counts?: { display_counts: number;guest_counts: number; };
enterprise_id?: DefsEnterpriseId;
has_pins?: boolean;
id: DefsChannel;
internal_team_ids?: DefsTeam[];
is_archived: boolean;
is_channel: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_general: boolean;
is_global_shared?: boolean;
is_group: boolean;
is_im: boolean;
is_member?: boolean;
is_moved?: number;
is_mpim: false;
is_non_threadable?: boolean;
is_open?: boolean;
is_org_default?: boolean;
is_org_mandatory?: boolean;
is_org_shared: boolean;
is_pending_ext_shared?: boolean;
is_private: boolean;
is_read_only?: boolean;
is_shared: boolean;
is_starred?: boolean;
is_thread_only?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
members?: DefsUserId[];
name: string;
name_normalized: string;
num_members?: number;
parent_conversation?: (DefsChannel | null)[];
pending_connected_team_ids?: DefsTeam[];
pending_shared?: DefsTeam[];
pin_count?: number;
previous_names?: DefsChannelName[];
priority?: number;
purpose: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
shared_team_ids?: DefsTeam[];
shares?: {
accepted_user?: DefsUserId;
is_active: boolean;
team: ObjsTeam;
user: DefsUserId;
}[];
timezone_count?: number;
topic: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
unlinked?: number;
unread_count?: number;
unread_count_display?: number;
use_case?: string;
user?: DefsUserId;
version?: number;
} | {
accepted_user?: DefsUserId;
connected_team_ids?: DefsTeam[];
conversation_host_id?: DefsWorkspaceId;
created: number;
creator: DefsUserId;
display_counts?: { display_counts: number;guest_counts: number; };
id: DefsChannel;
internal_team_ids?: DefsTeam[];
is_archived: boolean;
is_channel: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_general: boolean;
is_group: boolean;
is_im: boolean;
is_member?: boolean;
is_moved?: number;
is_mpim: true;
is_non_threadable?: boolean;
is_open?: boolean;
is_org_shared: boolean;
is_pending_ext_shared?: boolean;
is_private: boolean;
is_read_only?: boolean;
is_shared: boolean;
is_starred?: boolean;
is_thread_only?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
members?: DefsUserId[];
name: string;
name_normalized: string;
num_members?: number;
parent_conversation?: (DefsChannel | null)[];
pending_connected_team_ids?: DefsTeam[];
pending_shared?: DefsTeam[];
pin_count?: number;
previous_names?: DefsChannelName[];
priority?: number;
purpose: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
shared_team_ids?: DefsTeam[];
shares?: {
accepted_user?: DefsUserId;
is_active: boolean;
team: ObjsTeam;
user: DefsUserId;
}[];
timezone_count?: number;
topic: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
unlinked?: number;
unread_count?: number;
unread_count_display?: number;
user?: DefsUserId;
version?: number;
} | {
created: number;
has_pins?: boolean;
id: DefsDmId;
is_archived?: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_im: boolean;
is_open?: boolean;
is_org_shared: boolean;
is_shared?: boolean;
is_starred?: boolean;
is_user_deleted?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
parent_conversation?: (DefsChannel | null)[];
pin_count?: number;
priority: number;
shares?: {
date_create: number;
id: DefsTeam;
is_active: boolean;
name: string;
team: ObjsTeam;
}[];
unread_count?: number;
unread_count_display?: number;
user: DefsUserId;
version?: number;
})[]

[];ok:

DefsOkTrue

type DefsOkTrue = true

;response_metadata?: { next_cursor: string; }; }

default application/json

Typical error response

{
callstack?: string;
error: "missing_scope" | "not_authed" | "invalid_auth" | "account_inactive" | "invalid_arg_name" | "invalid_array_arg" | "invalid_charset" | "invalid_form_data" | "invalid_post_type" | "missing_post_type" | "invalid_json" | "json_not_object" | "request_timeout" | "upgrade_required";
needed?: string;
ok:

DefsOkFalse

type DefsOkFalse = false

;
provided?: string;
}