slack_kit

{
  "args": {
    "action_token": {
      "desc": "Send `action_token` as received in a message event.",
      "example": "12345.98765.abcd2358fdea",
      "required": false,
      "type": "string"
    },
    "after": {
      "desc": "UNIX timestamp filter. If present, filters for results after this date.",
      "example": "1754670081",
      "required": false,
      "type": "integer"
    },
    "before": {
      "desc": "UNIX timestamp filter. If present, filters for results before this date.",
      "example": "1754670081",
      "required": false,
      "type": "integer"
    },
    "channel_types": {
      "default": "public_channel",
      "desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`.",
      "example": "public_channel,private_channel",
      "required": false,
      "type": "array"
    },
    "content_types": {
      "default": "messages",
      "desc": "Content types to include, a comma-separated list of any combination of `messages`, `files`, `channels`, `users`.",
      "example": "messages,files",
      "required": false,
      "type": "array"
    },
    "context_channel_id": {
      "desc": "Context channel ID to support scoping the search when applicable.",
      "required": false
    },
    "cursor": {
      "desc": "The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results.",
      "example": "asf91j9jfd",
      "required": false,
      "type": "string"
    },
    "disable_semantic_search": {
      "desc": "Whether to disable semantic search. When true, only keyword-based search is used. Defaults to false.",
      "required": false,
      "type": "boolean"
    },
    "highlight": {
      "desc": "Whether to highlight the search query in the results. Defaults to false if unspecified.",
      "required": false,
      "type": "boolean"
    },
    "include_archived_channels": {
      "desc": "Whether to include archived channels in the search results.",
      "required": false,
      "type": "boolean"
    },
    "include_bots": {
      "desc": "Whether the results should include bots.",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "include_context_messages": {
      "desc": "Whether to include context messages surrounding the main message result. Defaults to false if unspecified.",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "include_deleted_users": {
      "desc": "Whether to include deleted users in the user search results. Defaults to false.",
      "example": "false",
      "required": false,
      "type": "boolean"
    },
    "include_message_blocks": {
      "desc": "Whether to return the message blocks in the response.",
      "required": false,
      "type": "boolean"
    },
    "limit": {
      "desc": "Number of results to return, up to a max of 20. Defaults to 20.",
      "example": "20",
      "required": false,
      "type": "integer"
    },
    "modifiers": {
      "desc": "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.",
      "example": "has:pin before:yesterday",
      "required": false,
      "type": "string"
    },
    "query": {
      "desc": "User prompt or search query",
      "example": "What is project gizmo?",
      "required": true,
      "type": "string"
    },
    "sort": {
      "default": "score",
      "desc": "The field to sort the results by. Defaults to score. Can be one of: score, timestamp.",
      "required": false,
      "type": "string"
    },
    "sort_dir": {
      "default": "desc",
      "desc": "The direction to sort the results by. Defaults to desc.",
      "required": false,
      "type": "string"
    },
    "term_clauses": {
      "desc": "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).",
      "required": false,
      "type": "array"
    }
  },
  "desc": "Searches messages, files, channels and users across your Slack organization.",
  "errors": {
    "assistant_search_context_disabled": "We're having issues returning your search results. Please wait and try again.",
    "context_channel_not_found": "Specified `context_channel_id` is invalid or the user lacks permission to view it.",
    "feature_not_enabled": "The feature is not available on the current workspace.",
    "invalid_action_token": "The `action_token` provided is not valid.",
    "invalid_cursor": "The cursormark provided is not valid.",
    "missing_query": "Missing query.",
    "query_too_long": "Query too long.",
    "rate_limited": "Rate limited."
  },
  "rate_limit": {
    "label": "Special rate limits apply.",
    "url": "https://docs.slack.dev/apis/web-api/rate-limits"
  },
  "scopes": {
    "bot": [
      {
        "name": "search:read.files",
        "url": "https://docs.slack.dev/reference/scopes/search.read.files"
      },
      {
        "name": "search:read.public",
        "url": "https://docs.slack.dev/reference/scopes/search.read.public"
      },
      {
        "name": "search:read.users",
        "url": "https://docs.slack.dev/reference/scopes/search.read.users"
      }
    ],
    "user": [
      {
        "name": "search:read.files",
        "url": "https://docs.slack.dev/reference/scopes/search.read.files"
      },
      {
        "name": "search:read.im",
        "url": "https://docs.slack.dev/reference/scopes/search.read.im"
      },
      {
        "name": "search:read.mpim",
        "url": "https://docs.slack.dev/reference/scopes/search.read.mpim"
      },
      {
        "name": "search:read.private",
        "url": "https://docs.slack.dev/reference/scopes/search.read.private"
      },
      {
        "name": "search:read.public",
        "url": "https://docs.slack.dev/reference/scopes/search.read.public"
      },
      {
        "name": "search:read.users",
        "url": "https://docs.slack.dev/reference/scopes/search.read.users"
      }
    ]
  }
}