Searches messages, files, channels and users across your Slack organization.

Required Params

• query - User prompt or search query ex: What is project gizmo?

Optional Params

• action_token - Send action_token as received in a message event. ex: 12345.98765.abcd2358fdea
• after - UNIX timestamp filter. If present, filters for results after this date. ex: 1754670081
• before - UNIX timestamp filter. If present, filters for results before this date. ex: 1754670081
• channel_types - Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im. ex: public_channel,private_channel
• content_types - Content types to include, a comma-separated list of any combination of messages, files, channels, users. ex: messages,files
• context_channel_id - Context channel ID to support scoping the search when applicable.
• cursor - The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results. ex: asf91j9jfd
• disable_semantic_search - Whether to disable semantic search. When true, only keyword-based search is used. Defaults to false.
• highlight - Whether to highlight the search query in the results. Defaults to false if unspecified.
• include_archived_channels - Whether to include archived channels in the search results.
• include_bots - Whether the results should include bots. ex: true
• include_context_messages - Whether to include context messages surrounding the main message result. Defaults to false if unspecified. ex: true
• include_deleted_users - Whether to include deleted users in the user search results. Defaults to false. ex: false
• include_message_blocks - Whether to return the message blocks in the response.
• limit - Number of results to return, up to a max of 20. Defaults to 20. ex: 20
• modifiers - A string containing only modifiers in the format of modifier:value. Search results returned will match the modifier value. For now modifiers only affect term clauses. ex: has:pin before:yesterday
• sort - The field to sort the results by. Defaults to score. Can be one of: score, timestamp.
• sort_dir - The direction to sort the results by. Defaults to desc.
• term_clauses - A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e., conjunctive normal form).

Errors the API can return:

• invalid_cursor - The cursormark provided is not valid.
• token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
• assistant_search_context_disabled - We're having issues returning your search results. Please wait and try again.
• invalid_arg_name - 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.
• two_factor_setup_required - Two factor setup is required.
• missing_query - Missing query.
• feature_not_enabled - The feature is not available on the current workspace.
• invalid_form_data - 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.
• rate_limited - Rate limited.
• invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
• fatal_error - The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
• deprecated_endpoint - The endpoint has been deprecated.
• ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
• ekm_access_denied - Administrators have suspended the ability to post a message.
• service_unavailable - The service is temporarily unavailable
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• invalid_arguments - The method was called with invalid arguments.
• invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
• request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• not_authed - No authentication token provided.
• internal_error - Internal error.
• enterprise_is_restricted - The method cannot be called from an Enterprise.
• query_too_long - Query too long.
• no_permission - The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
• access_denied - Access to a resource specified in the request is denied.
• team_added_to_org - 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.
• missing_scope - The requested channel types are not allowed by the provided scopes.
• missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
• accesslimited - Access to this method is limited on the current network
• token_expired - Authentication token has expired
• context_channel_not_found - Specified context_channel_id is invalid or the user lacks permission to view it.
• invalid_charset - 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.
• method_deprecated - The method has been deprecated.
• not_allowed_token_type - The token type used in this request is not allowed.
• org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
• invalid_auth - Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
• invalid_action_token - The action_token provided is not valid.

Returns search capabilities on a given team.

Errors the API can return:

• access_denied - Access to a resource specified in the request is denied.
• accesslimited - Access to this method is limited on the current network
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• deprecated_endpoint - The endpoint has been deprecated.
• ekm_access_denied - Administrators have suspended the ability to post a message.
• enterprise_is_restricted - The method cannot be called from an Enterprise.
• fatal_error - The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
• internal_error - The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
• invalid_arg_name - 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.
• invalid_arguments - The method was called with invalid arguments.
• invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
• invalid_auth - Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
• invalid_charset - 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.
• invalid_form_data - 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.
• invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
• method_deprecated - The method has been deprecated.
• missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
• missing_scope - The token used is not granted the specific scope permissions required to complete this request.
• no_permission - The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
• not_allowed_token_type - The token type used in this request is not allowed.
• not_authed - No authentication token provided.
• org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
• ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
• request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
• service_unavailable - The service is temporarily unavailable
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• team_added_to_org - 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.
• token_expired - Authentication token has expired
• token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
• two_factor_setup_required - Two factor setup is required.