Go to Slack


Searches for messages and files matching a query.

Supported token types:
Expected scopes:

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


This method has the URL https://slack.com/api/search.all and follows the Slack Web API calling conventions.

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required

Authentication token bearing required scopes.

query pickleface Required

Search query. May contains booleans, etc.

count 20 Optional, default=20

Number of items to return per page.

highlight true Optional

Pass a value of true to enable query highlight markers (see below).

page 2 Optional, default=1

Page number of results to return.

sort timestamp Optional, default=score

Return matches sorted by either score or timestamp.

sort_dir asc Optional, default=desc

Change sort direction to ascending (asc) or descending (desc).


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

    "ok": true,
    "query": "Best Pickles",
    "messages": {...},
    "files": {...}

Within each content group, data is returned in the following format:

    "matches": [],
    "paging": {
        "count": 100,  - number of records per page
        "total": 15,   - total records matching query
        "page": 1,     - page of records returned
        "pages": 1     - 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.


This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error Description

No authentication token provided.


Invalid authentication token.


Authentication token is for a deleted user or workspace.


The workspace token used in this request does not have the permissions necessary to complete the request.


This method cannot be called by a bot user.


The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.


The method was passed a PHP-style array argument (e.g. with a name like foo[7]). These are never valid with the Slack API.


The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.


The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.


The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/x-www-form-urlencoded multipart/form-data text/plain.


The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.


The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.


The method was called via a POST request, but the POST data was either missing or truncated.


This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning Description

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.


The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.