List Slash Commands

Prev Next
Get
/api/v1/commands.list

Lists all available slash commands.

Changelog

Version Description
0.60.2 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example50
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
sort
string

Sort the commands in ascending (1) or descending (-1) order. The value must be entered as a JSON string. The options are as follows:

  • command: Sort by command name. For example, sort={"command":1}
  • description: Sort by description. For example, sort={"description":-1}
Responses
200

OK

Success
{
  "commands": [
    {
      "command": "invite-all-from",
      "clientOnly": false
    },
    {
      "command": "slackbridge-import",
      "clientOnly": false
    },
    {
      "command": "gimme",
      "params": "your_message_optional",
      "description": "Slash_Gimme_Description",
      "clientOnly": false
    },
    {
      "command": "lennyface",
      "params": "your_message_optional",
      "description": "Slash_LennyFace_Description",
      "clientOnly": false
    },
    {
      "command": "shrug",
      "params": "your_message_optional",
      "description": "Slash_Shrug_Description",
      "clientOnly": false
    },
    {
      "command": "tableflip",
      "params": "your_message_optional",
      "description": "Slash_Tableflip_Description",
      "clientOnly": false
    },
    {
      "command": "unflip",
      "params": "your_message_optional",
      "description": "Slash_TableUnflip_Description",
      "clientOnly": false
    },
    {
      "command": "create",
      "clientOnly": false
    },
    {
      "command": "help",
      "clientOnly": false
    },
    {
      "command": "invite",
      "clientOnly": false
    },
    {
      "command": "invite-all-to",
      "clientOnly": false
    },
    {
      "command": "archive",
      "clientOnly": false
    },
    {
      "command": "join",
      "clientOnly": false
    },
    {
      "command": "kick",
      "clientOnly": false
    },
    {
      "command": "leave",
      "clientOnly": false
    },
    {
      "command": "part",
      "clientOnly": false
    },
    {
      "command": "me",
      "params": "your_message",
      "description": "Displays_action_text",
      "clientOnly": false
    },
    {
      "command": "msg",
      "clientOnly": false
    },
    {
      "command": "mute",
      "clientOnly": false
    },
    {
      "command": "unmute",
      "clientOnly": false
    },
    {
      "command": "topic",
      "params": "Slash_Topic_Params",
      "description": "Slash_Topic_Description",
      "clientOnly": false
    },
    {
      "command": "unarchive",
      "clientOnly": false
    }
  ],
  "offset": 0,
  "count": 22,
  "total": 22,
  "success": true
}
Expand All
object
commands
Array of object
object
command
string
clientOnly
boolean
offset
integer
count
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string