Skip to main content

search.all method

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Usage info​

This method allows users and applications to search both messages and files in a single call.

The team_id is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token.

Response​

The response returns matches broken down by their type of content, similar to the facebook/gmail auto-completed search widgets.

When using a user token with this method, search results will be affected by the search filters set in the Slack UI. Within each content group, data is returned in the following format:

{
    "matches": [],
    "paging": {
        "count": 100,
        "total": 15,
        "page": 1,
        "pages": 1
    }
}
  • count - number of records per page
  • total - total records matching query
  • page - page of records returned
  • pages - total pages matching query

This block gives the (estimated) total number of matches of this type, then has an array containing the specified page of the top matches. The format of matches depends on the match type, as described in the documentation for search.messages and search.files. These methods can be used to fetch further pages of messages or files.