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

Automation rule fields

GET /v1/bizproc-robots/fields

Returns the field schema of an automation rule: the type of each field and whether it is writable. The response describes the schema and does not query the automation rules registered in your Bitrix24 account.

Examples

The schema can be read only with an authorization key — both examples send an authorization key and the Authorization: Bearer header. The session token is issued by OAuth authorization, is valid for 24 hours, and cannot be renewed — Passing the key.

curl — authorization key

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

JavaScript — authorization key

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

const { success, data } = await res.json()
console.log(Object.keys(data.fields))

Response fields

Field Type Description
success boolean Always true on success
data.fields object Field schema: the key is the field name, the value is its description
data.fields.<name>.type string Value type: string, number, object
data.fields.<name>.readonly boolean true — the field is filled in by the system and is not passed in write requests
data.batch array Entity operations available in POST /v1/batch

Schema composition:

Field Type Description
code string Unique automation rule code. Serves as the identifier in update and delete paths
handler string Automation rule handler URL
name string Automation rule name
description string Automation rule description
authUserId number The user whose token is passed to the app when the automation rule is called. List: GET /v1/users
useSubscription string Whether to wait for the app's response before the rule continues: Y or N
properties object Automation rule input parameters
returnProperties object Automation rule output parameters
documentType object The document type the automation rule applies to
filter object INCLUDE and EXCLUDE rules by document type
usePlacement string Whether to open the automation rule settings in a slider panel: Y or N
placementHandler string URL of the settings slider panel

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "code": { "type": "string", "readonly": false },
      "handler": { "type": "string", "readonly": false },
      "name": { "type": "string", "readonly": false },
      "description": { "type": "string", "readonly": false },
      "authUserId": { "type": "number", "readonly": false },
      "useSubscription": { "type": "string", "readonly": false },
      "properties": { "type": "object", "readonly": false },
      "returnProperties": { "type": "object", "readonly": false },
      "documentType": { "type": "object", "readonly": false },
      "filter": { "type": "object", "readonly": false },
      "usePlacement": { "type": "string", "readonly": false },
      "placementHandler": { "type": "string", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}

Error response example

403 — the request was sent with an API 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
403 OAUTH_REQUIRED The request was sent with an API key. The schema is available only to an authorization key
401 TOKEN_MISSING Authorization key without the Authorization: Bearer header
401 WRONG_AUTH_SCHEME The authorization key was sent in the Authorization: Bearer header. The key goes in X-Api-Key, while Authorization: Bearer carries the session token
401 INVALID_SESSION The session token has expired or is invalid — authorize again
403 SCOPE_DENIED The key lacks the bizproc scope

The full list of common API errors — Errors.

Known specifics

The schema is the same for automation rules and activities. Both entities are described by the same set of twelve fields — the meaning differs, not the composition.

documentType is marked as object in the schema but is passed as an array. When you register or update an automation rule, the field accepts an array of three elements — module, object, type. For the value format, see automation rule registration.

See also