Open Channel configuration fields

GET /v1/openline-configs/fields

Returns the schema of fields available for filtering and sorting, as well as the full registry of fields in the list, get, and search responses.

Examples

curl — personal key

curl "https://vibecode.bitrix24.com/v1/openline-configs/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/openline-configs/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/openline-configs/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

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

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

Response fields

The /fields endpoint returns data.fields — a description of all fields in the list, get, and search responses: each field carries type, readonly, a label, and a description. Field names are in camelCase. The full set in get is 95 fields, in list/search — 91 (without the 4 operator queue fields). data additionally contains aggregatable and batch.

Field schema (data.fields)

/fields returns the full field set — each with type, readonly, label, and description. Filtering (filter), sorting (sort), and grouping (groupBy) operate on these camelCase names. Below are the core fields most often used in sort and filter:

data additionally specifies:

• aggregatable — fields available for groupBy: ["active", "queueType"]
• batch — the set of batch operations declared for this entity in the /fields response: empty array []

Full response field registry (list / get / search)

In get the data object contains 95 fields (all camelCase), in list/search — 91 (without the 4 fields marked "get only": queue, queueFull, queueUsersFields, queueOnline). A field name marked "get only" returns 400 UNSUPPORTED_LIST_FIELD when passed in select, filter or sort of the list and search methods.

Core

Queue and operators

CRM integration

Welcome message

Welcome bot

Working hours

Non-working-hours, no-answer, and close scenarios

Three groups of four fields each — scenario, form, bot, text:

Auto-close on inactivity

Quality rating

Agreements and categories

Wait form

Operator and session

KPI

Service

Response example

A few representative fields are shown. The full set is larger — 95 fields in get, 91 in list/search.

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Configuration identifier." },
      "name": { "type": "string", "readonly": false, "label": "Line name", "description": "Open line name." },
      "active": { "type": "boolean", "readonly": false, "label": "Line active", "description": "Line is active (true/false)." },
      "queueType": { "type": "string", "readonly": false, "label": "Distribution algorithm", "description": "Distribution algorithm: all — to everyone at once, evenly — evenly, strictly — strictly by queue order." },
      "crmCreate": { "type": "string", "readonly": false, "label": "CRM record to create", "description": "Type of CRM record created on first contact: none, lead, deal." },
      "welcomeMessage": { "type": "string", "readonly": false, "label": "Show welcome", "description": "Show welcome message: Y/N." },
      "workTimeFrom": { "type": "string", "readonly": false, "label": "Work day start", "description": "Work day start (for example 8, 9.30)." }
    },
    "aggregatable": ["active", "queueType"],
    "batch": []
  }
}

Error response example

403 — no scope:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "Access denied. Required scope: imopenlines"
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

A single set of names — camelCase. All fields in the list/get/search responses come back in camelCase. The /fields endpoint (data.fields) describes each field with type, readonly, label, and description. filter, sort, groupBy operate on these names. 91 fields total in list/search, 95 in get (the 4 operator queue fields are added). On write (create/update) camelCase is the canonical case. UPPER_SNAKE_CASE names are also accepted for backward compatibility. Boolean fields accept true/false on write (coerced to "Y"/"N").

Numeric fields come as strings. queueTime, noAnswerTime, autoCloseTime, maxChat, kpiFirstAnswerTime, and others — strings ("60", "180"). The exceptions are id (number) and active (boolean): these two fields are transformed by the Vibecode API schema.

dateCreate and dateModify are always empty objects {}. Bitrix24 does not pass date values through these fields.

See also

• List configurations
• Get configuration
• Entity API
• Filtering syntax