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": {
    "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.",
    "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.",
    "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.",
    "external_team_not_connected_to_this_org": "One of the teams provided in the external connected teams filter is not connected to the org.",
    "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.",
    "feature_not_enabled": "The token provided doesn't have access to this method.",
    "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": "The token provided does not belong to an Enterprise organization, or a specified workspace wasn't part of this Enterprise.",
    "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_cursor": "The provided cursor is not valid, often due to not urlencoding query parameters.",
    "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`.",
    "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.",
    "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": "The authenticated user does not have the permission to call this method.",
    "not_allowed_token_type": "The token type used in this request is not allowed.",
    "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.",
    "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.",
    "team_not_found": "One of the workspaces provided in the list wasn't found.",
    "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."
  }
}