Для AI-агентов: markdown этой страницы — /docs-content/entities/call-lists/get.md индекс документации — /llms.txt

Получить список

GET /v1/call-lists/:id

Возвращает один список обзвона по идентификатору, включая списки лидов и сделок, собранные в интерфейсе Битрикс24.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор списка обзвона, целое положительное число. Список: GET /v1/call-lists

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/call-lists/17" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/call-lists/17" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/call-lists/17', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`Список ${data.id}: участники типа ${data.entityType}`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/call-lists/17', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Список обзвона
data.id number Идентификатор списка обзвона
data.dateCreate string Дата создания строкой YYYY-MM-DD HH:mm:ss во времени портала, без часового пояса
data.createdById number Кто создал список. Список пользователей: GET /v1/users
data.webformId number | null CRM-форма, привязанная к списку, или null. Список форм: GET /v1/crm-forms
data.entityTypeId number Тип участников числом: 1 — лид, 2 — сделка, 3 — контакт, 4 — компания
data.entityType string Тот же тип строкой: LEAD, DEAL, CONTACT, COMPANY

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 17,
    "dateCreate": "2026-10-13 09:42:01",
    "createdById": 1317,
    "webformId": null,
    "entityTypeId": 3,
    "entityType": "CONTACT"
  }
}

Пример ответа при ошибке

404 — список не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Call list not found or inaccessible"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Списка с таким id нет или он недоступен владельцу ключа
400 INVALID_PARAMS id не целое положительное число, например abc или 0
400 INVALID_PARAMS Передан параметр в строке запроса, например ?select=id. Метод параметров строки запроса не принимает
422 BITRIX_ERROR Битрикс24 отклонил запрос. Текст причины — в message
502 BITRIX_RESPONSE_INVALID Ответ Битрикс24 не совпал с ожидаемой структурой списка
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING У ключа нет настроенных токенов Битрикс24
401 MISSING_API_KEY Не передан X-Api-Key

Полный список общих ошибок API — Ошибки.

Смотрите также