GET
/admin.conversations.searchSearch Enterprise organization channels
Searches public and private channels across an Enterprise organization. Use query, team_ids, and search_channel_types to narrow the search, and use sort with sort_dir to control result ordering. Pass cursor from the previous response to retrieve the next page.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
team_idsstringoptional
Comma-separated workspace IDs to search within.
querystringoptional
Channel name text to search for.
limitintegeroptional
Maximum number of results to return. Must be between 1 and 20; defaults to 10 when omitted.
cursorstringoptional
Pagination cursor from a previous response's `next_cursor` value.
search_channel_typesstringoptional
Channel type filter that controls which channel types are included or excluded, such as `private` or `private_exclude`.
sortstringoptional
Result sort field: `relevant`, `name`, `member_count`, or `created`.
sort_dirstringoptional
Result sort direction: `asc` for ascending or `desc` for descending.
tokenstringrequired
Authentication token with the `admin.conversations:read` scope.
200Returns a `channels` array containing matching channel objects and a `next_cursor` value for pagination.
channelsarray<ChannelObject>required
next_cursorstringrequired
defaultReturned when the search cannot be completed successfully; the response contains `ok: false` and an error value.
errorstringrequired
okbooleanrequired
Error handling
token must provide the admin.conversations:read scope. limit must be an integer from 1 through 20, sort must be one of the supported sort fields, and sort_dir must be asc or desc when supplied.