For AI agents: markdown of this page — /docs-content-en/entities/crm-forms/scenarios.md documentation index — /llms.txt

List scenarios

GET /v1/crm-forms/scenarios

Returns the CRM form builder scenarios — form templates for callback requests, online booking, product sales, event registration and other tasks.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-forms/scenarios" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-forms/scenarios" \
  -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/crm-forms/scenarios', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.map(scenario => `${scenario.id} — ${scenario.title}`))

JavaScript — OAuth application

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

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionAll builder scenarios. No pagination
Fielddata[].id Typestring DescriptionScenario ID, for example contacts, callback
Fielddata[].title Typestring DescriptionScenario name
Fielddata[].description Typestring DescriptionScenario description
Fielddata[].categoryId Typestring DescriptionScenario category. For the list, see Scenario categories
Fielddata[].iconUrl Typestring DescriptionPath to the scenario icon relative to the Bitrix24 account root URL, for example /bitrix/images/crm/webform/icons/contacts.svg
Fielddata[].sections Typearray of string DescriptionForm settings sections that belong to the scenario, for example fields, agreements, crm, design
Fielddata[].expertSections Typearray of string DescriptionExtended set of form settings sections
Fielddata[].defaultSection Typestring DescriptionDefault settings section, one of the sections values
Fielddata[].openable Typeboolean DescriptionWhether the scenario can be opened in the form builder
Fielddata[].soon Typeboolean DescriptionThe scenario is marked as coming soon
Fielddata[].actions Typearray of string DescriptionScenario actions, for example check, showHelp. An empty array if the scenario has no actions

Response example

Two of the 26 scenarios are shown:

JSON 
{
  "success": true,
  "data": [
    {
      "id": "contacts",
      "title": "Contact details",
      "description": "Get the customer's phone, email address and name",
      "categoryId": "crm",
      "iconUrl": "/bitrix/images/crm/webform/icons/contacts.svg",
      "sections": [
        "fields",
        "agreements",
        "header-and-button",
        "crm",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": []
    },
    {
      "id": "event_registration",
      "title": "Online events",
      "description": "Registration for an online event",
      "categoryId": "events",
      "iconUrl": "/bitrix/images/crm/webform/icons/online.svg",
      "sections": [
        "fields",
        "agreements",
        "crm",
        "header-and-button",
        "actions",
        "default-values",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": [
        "check"
      ]
    }
  ]
}

Error response example

400 — a query parameter is passed:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Unknown query parameter"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionThe endpoint accepts no query parameters
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe Bitrix24 user lacks permission to access forms
HTTP403 CodeBITRIX_INSUFFICIENT_SCOPE DescriptionThe Bitrix24 token lacks the required scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 did not find a requested entity or field descriptor. The original code is in error.b24Code
HTTP409 CodeCRM_FORM_REST_NOT_ENABLED DescriptionThe CRM form REST methods are unavailable on this Bitrix24 account. This does not mean that an individual form is missing
HTTP400–599 CodeCRM_FORM_* DescriptionRejection under form rules. The code and HTTP status are preserved. The original code is in error.b24Code
HTTP422 CodeBITRIX_ERROR DescriptionAnother Bitrix24 rejection. The reason is in error.message. The original code is in error.b24Code
HTTP429 CodeRATE_LIMITED DescriptionRequest rate exceeded. Follow the Retry-After header
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 returned an unexpected response shape
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable: a server error or a dropped connection
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time. The read can be retried
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured Bitrix24 credentials
HTTP403 CodeSCOPE_DENIED DescriptionThe Vibecode API key lacks the crm scope

Full list of common API errors — Errors.

See also