slack_kit

{
  "args": {
    "connected_team_ids": {
      "desc": "Array of encoded team IDs, signifying the external orgs to search through.",
      "example": "['T00000000','T00000001']",
      "required": false,
      "type": "array"
    },
    "cursor": {
      "desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
      "example": "dXNlcjpVMEc5V0ZYTlo=",
      "required": false,
      "type": "string"
    },
    "limit": {
      "default": "10",
      "desc": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.",
      "example": "20",
      "required": false,
      "type": "integer"
    },
    "query": {
      "desc": "Name of the the channel to query by.",
      "example": "announcement",
      "required": false,
      "type": "string"
    },
    "search_channel_types": {
      "desc": "The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the Types section.",
      "example": "private,archived",
      "required": false,
      "type": "array"
    },
    "sort": {
      "default": "member_count",
      "desc": "Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted",
      "example": "name",
      "required": false,
      "type": "string"
    },
    "sort_dir": {
      "default": "desc",
      "desc": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)",
      "example": "asc",
      "required": false,
      "type": "string"
    },
    "team_ids": {
      "desc": "Comma separated string of team IDs, signifying the internal workspaces to search through.",
      "example": "T00000000,T00000001",
      "required": false,
      "type": "array"
    },
    "total_count_only": {
      "desc": "Only return the total\\_count of channels. Omits channel data and allows access for admins without channel manager permissions.",
      "required": false,
      "type": "boolean"
    }
  },
  "desc": "Search for public or private channels in an Enterprise organization.",
  "errors": {
    "connected_team_passed_in_is_not_top_level_team": "One of the orgs provided in the external connected teams filter is not a top level team.",
    "external_team_not_connected_to_this_org": "One of the teams provided in the external connected teams filter is not connected to the org.",
    "feature_not_enabled": "The token provided doesn't have access to this method.",
    "invalid_cursor": "The provided cursor is not valid, often due to not urlencoding query parameters.",
    "invalid_search_channel_type": "An invalid `search_channel_types` arg was passed. Make sure there are no spaces between your args and that each is one of the enumerated options listed above.",
    "invalid_sort": "The provided `sort` argument wasn't valid.",
    "invalid_sort_dir": "The provided `sort_dir` argument wasn't valid.",
    "not_allowed": "The authenticated user does not have the permission to call this method.",
    "not_an_admin": "The token provided is not associated with an Org Admin or Owner.",
    "not_an_enterprise": "This endpoint can only be called by an Enterprise organization.",
    "team_not_found": "One of the workspaces provided in the list wasn't found."
  },
  "rate_limit": {
    "label": "Tier 2: 20+ per minute",
    "url": "https://docs.slack.dev/apis/web-api/rate-limits"
  },
  "scopes": {
    "user": [
      {
        "name": "admin.conversations:read",
        "url": "https://docs.slack.dev/reference/scopes/admin.conversations.read"
      }
    ]
  }
}