Slack. Web. Search
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Searches for messages and files matching a query.
Searches for files matching a query.
Searches for messages matching a query.
Functions
Searches for messages and files matching a query.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
search:read
Required Params
query- Search query. May contains booleans, etc. ex:pickleface
Optional Params
count-highlight- Pass a value oftrueto enable query highlight markers (see below). ex:truepage-sort- Return matches sorted by eitherscoreortimestamp. ex:timestampsort_dir- Change sort direction to ascending (asc) or descending (desc). ex:ascteam_id- encoded team id to search in, required if org token is used
Errors the API can return:
no_query- No query was provided.
See the Common Errors guide for errors returned by every Web API method.
Searches for files matching a query.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
search:read
Required Params
query- Search query. ex:pickleface
Optional Params
count-highlight- Pass a value oftrueto enable query highlight markers (see below). ex:truepage-sort- Return matches sorted by eitherscoreortimestamp. ex:timestampsort_dir- Change sort direction to ascending (asc) or descending (desc). ex:ascteam_id- encoded team id to search in, required if org token is used
Errors the API can return:
no_query- No query was provided.
See the Common Errors guide for errors returned by every Web API method.
Searches for messages matching a query.
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
search:read
Required Params
query- Search query. ex:pickleface
Optional Params
count- Pass the number of results you want per "page". Maximum of100.cursor- Use this when getting results with cursormark pagination. For first call send*for subsequent calls, send the value ofnext_cursorreturned in the previous call's resultshighlight- Pass a value oftrueto enable query highlight markers (see below). ex:truepage-sort- Return matches sorted by eitherscoreortimestamp. ex:timestampsort_dir- Change sort direction to ascending (asc) or descending (desc). ex:ascteam_id- encoded team id to search in, required if org token is used
Errors the API can return:
no_query- No query was provided.
See the Common Errors guide for errors returned by every Web API method.