List Open Channel configurations

GET /v1/openline-configs

Returns a list of Open Channel configurations with support for filtering, sorting, and pagination.

Parameters

Examples

curl — personal key

curl -g "https://vibecode.bitrix24.com/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl -g "https://vibecode.bitrix24.com/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true" \
  -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?limit=10&sort=id&order=asc&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, total, hasMore } = await res.json()
console.log(`Received ${data.length} configurations, total in the window: ${total}`)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/openline-configs?limit=10&sort=id&order=asc&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

The response contains metadata fields at the top level (not nested in meta):

Response example

Core fields are shown. Full list: Configuration fields.

{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Open Channel",
      "queueType": "all",
      "workTimeFrom": "8",
      "workTimeTo": "17",
      "crm": "Y",
      "crmCreate": "deal",
      "queueTime": "60",
      "noAnswerTime": "180",
      "welcomeMessage": "Y",
      "workTimeEnable": "Y",
      "workTimeTimezone": "UTC",
      "dateCreate": {},
      "dateModify": {}
    },
    {
      "id": 3,
      "active": true,
      "name": "Wix",
      "queueType": "all",
      "workTimeFrom": "9",
      "workTimeTo": "18.30",
      "crm": "Y",
      "crmCreate": "deal",
      "queueTime": "60",
      "noAnswerTime": "180",
      "welcomeMessage": "Y",
      "workTimeEnable": "N",
      "workTimeTimezone": "UTC",
      "dateCreate": {},
      "dateModify": {}
    }
  ],
  "total": 7,
  "limit": 10,
  "offset": 0,
  "hasMore": false
}

The example shows 2 records out of 7 — the other 5 are omitted for brevity. Each element contains roughly 75 more fields beyond those shown. The page is shorter than limit, so hasMore is false.

Error response example

400 — an $or / $and logical operator in the filter (Bitrix24 does not support OR/AND for this method):

{
  "success": false,
  "error": {
    "code": "INVALID_FILTER_OPERATOR",
    "message": "'$or' is not supported. OR/AND logic cannot be expressed in a single openline-configs filter. For same-field OR use { field: { $in: [v1, v2] } }. For cross-field OR run parallel requests. AND is the default — combine conditions as sibling keys in one filter object."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

total is the current-window count, not the overall total. Bitrix24 does not return the total number of configurations for the list method, so total holds the number of records on the current page only. To check for the next page, use the hasMore field.

hasMore is the only next-page signal. Walk pages using it rather than doing arithmetic over total. For a limit between 1 and 199 the flag is exact. At limit=200 (the ceiling) it means "the page came back full", so the last full page may be followed by one empty response — that is a normal end of the walk, not an error.

A fractional or too small limit is replaced by the default. The page size is a whole number from 1 to 200. A value below one (0, 0.5, negative) and a non-numeric value are discarded and 50 is applied. A fractional value above one is rounded down: 2.7 yields a page of 2 records.

Filtering and sorting — the 6 camelCase schema fields. The filter and sort parameters work on all 6 documented names: id, name, active, queueType, workTimeFrom, workTimeTo (the wrapper maps them to the real Bitrix24 names on the request side).

Other fields are also accepted. To filter or sort by a field outside these six (for example crmCreate, languageId), pass its camelCase name from Configuration fields — that is the canonical casing. UPPER_SNAKE_CASE names are also accepted for backward compatibility. An unknown field returns 422 BITRIX_ERROR.

OR/AND in the filter are not supported. The operators $or / $and / $not / LOGIC are rejected with 400 INVALID_FILTER_OPERATOR — OR/AND logic cannot be expressed in a single filter. For OR on a single field use { "id": { "$in": [1, 3] } } (in a query string: filter[id][$in]=1,3).

The queue, queueFull, queueUsersFields, queueOnline fields are not returned in the list — they are available only in Get configuration. Naming any of them in select, filter or sort returns 400 UNSUPPORTED_LIST_FIELD, and the response names the spelling you passed along with the route that does serve these fields.

camelCase and empty dates. Each record contains ~91 fields, all in camelCase. dateCreate and dateModify come back as empty objects {}. /fields describes every field with a label and description — see Configuration fields for the full registry and explanations.

See also

• Get configuration
• Create configuration
• Configuration fields
• Filtering syntax
• Entity API
• Limits and optimization