admin conversations search
GET {{baseUrl}}/admin.conversations.search?team_ids=<string>&query=<string>&limit=<integer>&cursor=<string>&search_channel_types=<string>&sort=<string>&sort_dir=<string>
Search for public or private channels in an Enterprise organization.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
team_ids | string | Comma separated string of team IDs, signifying the workspaces to search through. | |
query | string | Name of the the channel to query by. | |
limit | string | Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. | |
cursor | string | Set cursor to next_cursor returned by the previous call to list items in the next page. | |
search_channel_types | string | The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section. | |
sort | string | Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted | |
sort_dir | string | Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a) |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
token | string | (Required) Authentication token. Requires scope: admin.conversations:read |
RESPONSES
status: OK
{"channels":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","created":"\u003cinteger\u003e","creator":"\u003cstring\u003e","is_channel":"\u003cboolean\u003e","is_org_shared":"\u003cboolean\u003e","is_private":"\u003cboolean\u003e","is_mpim":"\u003cboolean\u003e","is_shared":"\u003cboolean\u003e","name_normalized":"\u003cstring\u003e","members":["\u003cstring\u003e"],"topic":{"value":"\u003cstring\u003e","creator":"\u003cstring\u003e","last_set":"\u003cinteger\u003e"},"purpose":{"value":"\u003cstring\u003e","creator":"\u003cstring\u003e","last_set":"\u003cinteger\u003e"},"accepted_user":"\u003cstring\u003e","is_archived":"\u003cboolean\u003e","is_frozen":"\u003cboolean\u003e","is_general":"\u003cboolean\u003e","is_member":"\u003cboolean\u003e","is_moved":"\u003cinteger\u003e","is_non_threadable":"\u003cboolean\u003e","is_pending_ext_shared":"\u003cboolean\u003e","is_read_only":"\u003cboolean\u003e","is_thread_only":"\u003cboolean\u003e","last_read":"\u003cstring\u003e","latest":{},"num_members":"\u003cinteger\u003e","pending_shared":["\u003cstring\u003e"],"previous_names":["\u003cstring\u003e"],"priority":"\u003cnumber\u003e","unlinked":"\u003cinteger\u003e","unread_count":"\u003cinteger\u003e","unread_count_display":"\u003cinteger\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","created":"\u003cinteger\u003e","creator":"\u003cstring\u003e","is_channel":"\u003cboolean\u003e","is_org_shared":"\u003cboolean\u003e","is_private":"\u003cboolean\u003e","is_mpim":"\u003cboolean\u003e","is_shared":"\u003cboolean\u003e","name_normalized":"\u003cstring\u003e","members":["\u003cstring\u003e"],"topic":{"value":"\u003cstring\u003e","creator":"\u003cstring\u003e","last_set":"\u003cinteger\u003e"},"purpose":{"value":"\u003cstring\u003e","creator":"\u003cstring\u003e","last_set":"\u003cinteger\u003e"},"accepted_user":"\u003cstring\u003e","is_archived":"\u003cboolean\u003e","is_frozen":"\u003cboolean\u003e","is_general":"\u003cboolean\u003e","is_member":"\u003cboolean\u003e","is_moved":"\u003cinteger\u003e","is_non_threadable":"\u003cboolean\u003e","is_pending_ext_shared":"\u003cboolean\u003e","is_read_only":"\u003cboolean\u003e","is_thread_only":"\u003cboolean\u003e","last_read":"\u003cstring\u003e","latest":{},"num_members":"\u003cinteger\u003e","pending_shared":["\u003cstring\u003e"],"previous_names":["\u003cstring\u003e"],"priority":"\u003cnumber\u003e","unlinked":"\u003cinteger\u003e","unread_count":"\u003cinteger\u003e","unread_count_display":"\u003cinteger\u003e"}],"next_cursor":"\u003cstring\u003e"}