For AI agents: markdown of this page — /docs-content-en/entities/bizproc-robots/list.md documentation index — /llms.txt

Automation rule list

GET /v1/bizproc-robots

Returns the list of automation rule codes registered on the Bitrix24 account. Each response element is an automation rule code represented as a string and used in the update and delete paths.

The method works only with an authorization key. The session token is issued by OAuth authorization, is valid for 24 hours, and cannot be renewed — Passing the key.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionMaximum number of codes in the response
Parameteroffset Typenumber Default0 DescriptionNumber of codes to skip from the beginning of the full list
Parameterselect Typestring Default— DescriptionAccepted, but does not change the response: the data items are code strings
ParameterwithTotal Typeboolean Default— DescriptionAccepted, but does not change the response: meta.total is returned for any value of the parameter

Sorting is not supported: sort and order return 400 INVALID_SORT_FIELD. Filtering is not supported either: filter returns 400 UNSUPPORTED_FILTER.

Examples

curl — OAuth application

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

JavaScript — OAuth application

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

const { success, data, meta } = await res.json()
console.log(`Registered automation rules: ${meta.total}`)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of strings — the codes of registered automation rules
Fieldmeta.total Typenumber DescriptionNumber of codes in the full list, not the current page
Fieldmeta.hasMore Typeboolean DescriptionWhether more codes remain after the current page

Response example

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

Error response example

403 — an API key was used on a method available only to an authorization key:

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)."
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_SORT_FIELD Descriptionsort or order was supplied; the list method does not support sorting
HTTP400 CodeUNSUPPORTED_FILTER Descriptionfilter was supplied. The list method does not filter — filter the codes on the client side
HTTP403 CodeOAUTH_REQUIRED DescriptionCalled with an API key. The method is available only to an authorization key
HTTP401 CodeTOKEN_MISSING DescriptionThe authorization key was sent without the Authorization: Bearer <session> header
HTTP401 CodeWRONG_AUTH_SCHEME DescriptionThe authorization key was sent in the Authorization: Bearer header. The key goes in X-Api-Key, while Authorization: Bearer carries the session token
HTTP401 CodeINVALID_SESSION DescriptionThe session token has expired or is invalid — authorize again
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the bizproc scope
HTTP409 CodeBIZPROC_MODULE_NOT_ENABLED DescriptionBusiness Processes are not available on the account: the module is not included in the plan, or it is switched off in account settings. Ask an account administrator to enable Business Processes — until then the method returns the same response regardless of how many times you retry
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

Known specifics

An empty list is a successful response. Until at least one automation rule is registered on the Bitrix24 account, data comes back as an empty array with code 200. The absence of automation rules is not an error.

See also