Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-robots/list.md индекс документации — /llms.txt
Список роботов
GET /v1/bizproc-robots
Возвращает список кодов роботов автоматизации, зарегистрированных на портале. Каждый элемент ответа — символьный код робота, который используется в путях обновления и удаления.
Метод работает только с ключом авторизации. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.
Параметры
| Параметр | Тип | По умолч. | Описание |
|---|---|---|---|
Параметрlimit |
Типnumber | По умолч.50 |
ОписаниеМаксимальное количество кодов в ответе |
Параметрoffset |
Типnumber | По умолч.0 |
ОписаниеКоличество кодов, которые нужно пропустить от начала полного списка |
Параметрselect |
Типstring | По умолч.— | ОписаниеПринимается, но на ответ не влияет: элементы data — строки-коды |
ПараметрwithTotal |
Типboolean | По умолч.— | ОписаниеПринимается, но на ответ не влияет: meta.total приходит при любом значении |
Сортировка не поддерживается: sort и order возвращают 400 INVALID_SORT_FIELD. Фильтрация тоже не поддерживается: filter возвращает 400 UNSUPPORTED_FILTER.
Примеры
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/bizproc-robots" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — OAuth-приложение
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 | ОписаниеЕсть ли ещё коды после текущей страницы |
Пример ответа
{
"success": true,
"data": [
"deal_notify",
"sms_sender"
],
"meta": {
"total": 2,
"hasMore": false
}
}
Пример ответа при ошибке
403 — вызов API-ключом на методе только для ключа авторизации:
{
"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 | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_SORT_FIELD |
ОписаниеПередан sort или order. Метод списка не поддерживает сортировку |
| HTTP400 | КодUNSUPPORTED_FILTER |
ОписаниеПередан filter. Метод списка не фильтрует — отбирайте коды на своей стороне |
| HTTP403 | КодOAUTH_REQUIRED |
ОписаниеВызов API-ключом. Метод доступен только ключу авторизации |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеКлюч авторизации передан без заголовка Authorization: Bearer <сессия> |
| HTTP401 | КодWRONG_AUTH_SCHEME |
ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии |
| HTTP401 | КодINVALID_SESSION |
ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа bizproc |
| HTTP409 | КодBIZPROC_MODULE_NOT_ENABLED |
ОписаниеБизнес-процессов на портале нет: модуль не входит в тариф либо выключен в настройках портала. Попросите администратора портала включить бизнес-процессы — до этого метод отвечает так же при любом числе повторов |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After |
Полный список общих ошибок API — Ошибки.
Известные особенности
Пустой список — успешный ответ. Пока на портале не зарегистрировано ни одного робота, data приходит пустым массивом с кодом 200. Отсутствие роботов — не ошибка.