Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-robots/list.md индекс документации — /llms.txt

Список роботов

GET /v1/bizproc-robots

Возвращает список кодов роботов автоматизации, зарегистрированных на портале. Каждый элемент ответа — символьный код робота, который используется в путях обновления и удаления.

Метод работает только с ключом авторизации. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.

Параметры

Параметр Тип По умолч. Описание
limit number 50 Максимальное количество кодов в ответе

Примеры

curl — ключ авторизации

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bizproc-robots" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — ключ авторизации

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

const { success, data, meta } = await res.json()
console.log(`Зарегистрировано роботов: ${meta.total}`)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив строк — коды зарегистрированных роботов
meta.total number Количество кодов в ответе
meta.hasMore boolean Есть ли ещё записи за пределами limit

Пример ответа

JSON 
{
  "success": true,
  "data": [
    "deal_notify",
    "sms_sender"
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

Пример ответа при ошибке

403 — вызов API-ключом на методе только для ключа авторизации:

JSON 
{
  "success": false,
  "error": {
    "code": "OAUTH_REQUIRED",
    "message": "bizproc-robots require an OAuth app key (vibe_app_*) with an Authorization: Bearer session — a personal vibe_api_* key lacks the per-user OAuth context Bitrix24 needs for these methods. Create an OAuth app (POST /v1/apps) and retry with its key. On this 403 switch keys — do NOT delete or recreate the app (that discards anything already registered under it, e.g. a bizproc robot you just registered)."
  }
}

Ошибки

HTTP Код Описание
403 OAUTH_REQUIRED Вызов API-ключом. Метод доступен только ключу авторизации
401 TOKEN_MISSING Ключ авторизации передан без заголовка Authorization: Bearer <сессия>
401 WRONG_AUTH_SCHEME Ключ авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии
401 INVALID_SESSION Токен сессии истёк или недействителен — пройдите авторизацию заново
403 SCOPE_DENIED Ключу не хватает скоупа bizproc

Полный список общих ошибок API — Ошибки.

Известные особенности

Пустой список — успешный ответ. Пока на портале не зарегистрировано ни одного робота, data приходит пустым массивом с кодом 200. Отсутствие роботов — не ошибка.

Смотрите также