List commands

GET /v1/bots/:botId/commands

Returns the commands registered for the bot together with the system commands of the Bitrix24 account.

Parameters

Examples

curl — personal key

curl https://vibecode.bitrix24.com/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl https://vibecode.bitrix24.com/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/commands', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Commands:', data.commands)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/commands', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Response example

Two of the six system commands of the Bitrix24 account and one bot command are shown:

{
  "success": true,
  "data": {
    "commands": [
      {
        "id": "def0",
        "botId": 0,
        "command": "/me",
        "category": "Chat and calls",
        "common": "Y",
        "context": "",
        "title": "Text will be shown in italics",
        "params": "text",
        "extranet": "Y"
      },
      {
        "id": "def3",
        "botId": 0,
        "command": "/rename",
        "category": "Chats",
        "common": "Y",
        "context": "chat",
        "title": "Change the chat title",
        "params": "new title",
        "extranet": "Y"
      },
      {
        "id": 229,
        "botId": 42,
        "command": "/help",
        "category": "Support",
        "common": "Y",
        "context": "",
        "title": "Help",
        "params": "topic",
        "extranet": "N"
      }
    ]
  }
}

Error response example

404 — bot not found:

{
  "success": false,
  "error": {
    "code": "BOT_NOT_FOUND",
    "message": "Bot 999 not found. Register it first via POST /v1/bots."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

Pick the bot's commands out of the shared list. The system commands of the Bitrix24 account come in every response, and their botId is 0. To get only your bot's commands, filter data.commands to the items whose botId matches the bot ID.

The list may lag behind changes. Vibecode does not cache this response, but Bitrix24 updates the command list with a delay after a command is registered, updated or deleted: from several seconds to several minutes. During this time, GET may return:

• deleted commands — their IDs are still visible in the list.
• stale title, params and common values for a command that was just updated.
• a list without a command that was just registered.

The command itself is already active at that point: its call arrives as an ONIMBOTV2COMMANDADD event, and the bot handles it. The discrepancy is visible only in this GET. The list cache cannot be force-reset.

How to work with the delay. Right after a change, rely on the response of the change request itself: POST returns the data with the new ID, PATCH returns the updated command, DELETE returns a success flag. If you need to reconcile the list with the actual state, repeat GET after 10–30 seconds.

See also

• Register a command
• Update a command
• Bot platform
• Limits and optimization