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

Список элементов смарт-процесса

GET /v1/items/:entityTypeId

Возвращает список элементов указанного смарт-процесса с фильтрацией, сортировкой и пагинацией.

Параметры

Параметр Тип По умолч. Описание
entityTypeId (path) number — ID типа смарт-процесса. Список: GET /v1/smart-processes
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей. Для обхода всей коллекции дешевле курсор — order[id]=asc и filter[>id] из meta.nextAfterId
order object — Сортировка: ?order[createdTime]=desc
select string — Выборка полей: ?select=id,title,stageId
filter object — Фильтрация по полям GET /v1/items/:entityTypeId/fields.
Синтаксис фильтрации. Пример: ?filter[assignedById]=1
withTotal string — Нужно ли количество: true или false. false — не заказывать подсчёт. Это единственный способ гарантированно убрать meta.total из ответа. Без параметра — настройка ключа, затем платформенное умолчание, и тогда на короткой странице точное количество приходит и без заказа. Листание и количество

Примеры

В примерах entityTypeId = 156 — замените на ID вашего смарт-процесса.

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/items/156?limit=10&order[createdTime]=desc&filter[assignedById]=1" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/items/156?limit=10&order[createdTime]=desc&filter[assignedById]=1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[assignedById]': '1',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/items/156?${params}`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data, meta } = await res.json()
console.log(`Найдено: ${meta.total}`)

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

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[assignedById]': '1',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/items/156?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Пагинация возвращается в объекте meta (как у всех списочных эндпоинтов платформы), не на верхнем уровне.

Поле Тип Описание
data array Массив элементов
meta.total number Общее количество записей. Необязательное поле: если количество не заказывалось, его в ответе нет
meta.hasMore boolean Есть ли ещё страницы
meta.nextAfterId string Идентификатор последней отданной записи. Приходит при сортировке строго по id по возрастанию, пока hasMore равен true. Передайте его обратно как filter[>id] — это дешёвая замена растущему offset
data[].id number ID элемента
data[].title string Название
data[].stageId string Стадия
data[].categoryId number ID воронки
data[].opportunity number Сумма
data[].currencyId string Валюта
data[].assignedById number Ответственный
data[].createdTime datetime Дата создания

URL карточки любого элемента из массива data — его id:

https://<portal>.bitrix24.ru/crm/type/<entityTypeId>/details/<id>/

<entityTypeId> — ID типа смарт-процесса (тот же, что в пути запроса). <portal> — домен портала. Если смарт-процесс вынесен в отдельный раздел портала, Битрикс24 откроет карточку по соответствующему пути. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 783,
      "title": "Договор на поставку",
      "stageId": "DT156_41:NEW",
      "categoryId": 41,
      "companyId": 15,
      "contactId": 42,
      "opportunity": 500000,
      "currencyId": "RUB",
      "assignedById": 1,
      "createdBy": 1,
      "createdTime": "2026-04-15T14:30:00+03:00",
      "updatedTime": "2026-04-15T14:30:00+03:00"
    }
  ],
  "meta": { "total": 23, "hasMore": true }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 INVALID_DYNAMIC_PARAM entityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
400 UNKNOWN_FILTER_FIELD Поле фильтра не существует у сущности — сообщение перечисляет доступные поля

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

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