GET /admin.conversations.search

Search for public or private channels in an Enterprise organization.

Servers

Request headers

Name Type Required Description
token String Yes

Authentication token. Requires scope: admin.conversations:read

Query parameters

Name Type Required Description
query String No

Name of the the channel to query by.

limit Integer No

Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.

sort_dir String No

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)

sort String No

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

team_ids String No

Comma separated string of team IDs, signifying the workspaces to search through.

cursor String No

Set cursor to next_cursor returned by the previous call to list items in the next page.

search_channel_types String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.