Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods search.messages.json
Raw

priv/docs/methods/search.messages.json

{
"args": {
"count": {
"default": "20",
"desc": "Pass the number of results you want per \"page\". Maximum of `100`.",
"required": false,
"type": "integer"
},
"cursor": {
"desc": "Use this when getting results with cursormark pagination. For first call send `*` for subsequent calls, send the value of `next_cursor` returned in the previous call's results",
"required": false,
"type": "string"
},
"highlight": {
"desc": "Pass a value of `true` to enable query highlight markers (see below).",
"example": "true",
"required": false,
"type": "boolean"
},
"page": {
"default": "1",
"desc": "",
"required": false,
"type": "integer"
},
"query": {
"desc": "Search query.",
"example": "pickleface",
"required": true,
"type": "string"
},
"sort": {
"default": "score",
"desc": "Return matches sorted by either `score` or `timestamp`.",
"example": "timestamp",
"required": false,
"type": "string"
},
"sort_dir": {
"default": "desc",
"desc": "Change sort direction to ascending (`asc`) or descending (`desc`).",
"example": "asc",
"required": false,
"type": "string"
},
"team_id": {
"desc": "encoded team id to search in, required if org token is used",
"required": false,
"type": "string"
}
},
"desc": "Searches for messages matching a query.",
"errors": { "no_query": "No query was provided." },
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "search:read",
"url": "https://docs.slack.dev/reference/scopes/search.read"
}
]
}
}