For AI agents: markdown of this page — /docs-content-en/openlines/config/get.md documentation index — /llms.txt

Get Open Channel configuration

GET /v1/openline-configs/:id

Returns an Open Channel configuration by ID with all fields, including operator queue data.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionConfiguration ID

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data } = await res.json()
console.log('Channel:', data.name, '— queue type:', data.queueType)

JavaScript — OAuth application

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

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

Response fields

The response contains 95 fields, all in camelCase — /fields describes each field with a label and description: Open Channel fields.

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionConfiguration object (all fields — see Open Channel fields)

Response example

Key fields are shown. Full list: Open Channel fields.

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "active": true,
    "name": "Open Channel",
    "queueType": "all",
    "workTimeFrom": "8",
    "workTimeTo": "17",
    "crm": "Y",
    "crmCreate": "deal",
    "queueTime": "60",
    "noAnswerTime": "180",
    "workTimeEnable": "Y",
    "workTimeTimezone": "UTC",
    "welcomeMessage": "Y",
    "voteMessage": "Y",
    "queue": ["139", "131", "99"],
    "queueFull": {
      "99": {
        "ID": "59",
        "SORT": "2",
        "USER_ID": "99",
        "DEPARTMENT_ID": "0",
        "USER_NAME": "John Smith",
        "USER_WORK_POSITION": "Support manager",
        "USER_AVATAR": "/upload/main/avatars/99.jpg",
        "USER_AVATAR_ID": "12345"
      },
      "131": {
        "ID": "57",
        "SORT": "1",
        "USER_ID": "131",
        "DEPARTMENT_ID": "0",
        "USER_NAME": "Mary Johnson",
        "USER_WORK_POSITION": "Senior operator",
        "USER_AVATAR": "/upload/main/avatars/131.jpg",
        "USER_AVATAR_ID": "67890"
      }
    },
    "queueUsersFields": {
      "99": { "USER_NAME": "John Smith", "USER_WORK_POSITION": "Support manager", "USER_AVATAR": "/upload/main/avatars/99.jpg" },
      "131": { "USER_NAME": "Mary Johnson", "USER_WORK_POSITION": "Senior operator", "USER_AVATAR": "/upload/main/avatars/131.jpg" }
    },
    "queueOnline": "N",
    "dateCreate": {},
    "dateModify": {}
  }
}

Error response example

404 — configuration not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "openlineConfig 99999 not found"
  }
}

Errors

HTTP Code Description
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the imopenlines scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo configuration with this ID was found

Full list of common API errors — Errors.

Known specifics

The operator queue fields are available only here. queue, queueFull, queueUsersFields, queueOnline are returned by the single-record request and are not available in List Open Channel configurations or Search Open Channel configurations.

The full list of all 95 fields (all in camelCase, with label and description) and the empty dateCreate/dateModify — Configuration fields.

See also