For AI agents: markdown of this page — /docs-content-en/bots/management/revision.md documentation index — /llms.txt

Bot platform revision

GET /v1/bots/revision

Returns the Bitrix24 bot platform revision numbers by client type. Does not require a bot ID. No request body is required.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bots/revision', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data) // { rest: 35, web: 130, mobile: 25, desktop: 6 }

JavaScript — OAuth application

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

Response fields

Field Type Description
Fielddata.rest Typenumber DescriptionRevision of the bot platform's REST capabilities
Fielddata.web Typenumber DescriptionWeb client revision
Fielddata.mobile Typenumber DescriptionMobile client revision
Fielddata.desktop Typenumber DescriptionDesktop client revision

Response example

JSON 
{
  "success": true,
  "data": {
    "rest": 35,
    "web": 130,
    "mobile": 25,
    "desktop": 6
  }
}

Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'imbot' scope"
  }
}

Errors

HTTP Code Description
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the imbot scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

Purpose of the rest field. The value grows when Bitrix24 ships new bot platform REST capabilities. Comparing a stored value with the current one shows that new bot platform methods and events have appeared on your Bitrix24 account.

See also