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

Поиск дел

POST /v1/activities/search

Поиск дел с фильтрами через POST — удобнее для сложных запросов.

Поля запроса (body)

Параметр Тип По умолч. Описание
Параметрfilter Типobject По умолч.— ОписаниеФильтрация по полям GET /v1/activities/fields.
Синтаксис фильтрации. Пример: ?filter[ownerTypeId]=2&filter[ownerId]=741
Параметрlimit Типnumber По умолч.50 ОписаниеКоличество записей (до 5000)
Параметрoffset Типnumber По умолч.0 ОписаниеПропустить N записей. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. UNSTABLE_OFFSET_PAGINATION в разделе «Ошибки»
Параметрorder Типobject По умолч.— ОписаниеСортировка: { "deadline": "asc" }
Параметрselect Типstring[] По умолч.— ОписаниеВыборка полей: ["id", "subject", "typeId", "completed"]
Параметрinclude Типstring[] По умолч.— ОписаниеСвязанные сотрудники: ["responsible", "author"]. Доступны responsible, author, editor, принимается и строка через запятую. Карточки приходят в поле _included каждого элемента data. Связь читает сотрудника, поэтому ключу кроме crm нужен скоуп user. Состав связей и пример ответа — Список дел
ПараметрautoWindow Типboolean По умолч.true ОписаниеРазбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. false отключает разбиение

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/activities/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "ownerTypeId": 2, "ownerId": 741, "completed": false },
    "limit": 20,
    "order": { "deadline": "asc" }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/activities/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "ownerTypeId": 2, "ownerId": 741, "completed": false },
    "limit": 20,
    "order": { "deadline": "asc" }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { ownerTypeId: 2, ownerId: 741, completed: false },
    limit: 20,
    order: { deadline: 'asc' },
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { ownerTypeId: 2, ownerId: 741, completed: false },
    limit: 20,
    order: { deadline: 'asc' },
  }),
})

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

Поля ответа

Поле Тип Описание
Полеdata Типarray ОписаниеМассив дел (поля — см. Поля)
Полеmeta.total Типnumber ОписаниеСколько записей подошло под фильтр
Полеmeta.hasMore Типboolean ОписаниеЕсть ли ещё записи за пределами limit
Полеmeta.durationMs Типnumber ОписаниеДлительность запроса в миллисекундах
Полеmeta.autoWindowed Типboolean Описаниеtrue, если выборка была разбита по временны́м окнам
Полеmeta.windowCount Типnumber ОписаниеЧисло окон. Приходит при autoWindowed: true
Полеmeta.batchWaves Типnumber ОписаниеЧисло волн параллельных запросов. Приходит при autoWindowed: true
Полеmeta.includeSkipped Типboolean Описаниеtrue, если в ответе больше 200 записей и связи из include не загружены. Уменьшите limit. При 200 записях и меньше ключа нет

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3894,
      "typeId": 1,
      "ownerTypeId": 2,
      "ownerId": 741,
      "subject": "Встреча по проекту",
      "responsibleId": 1,
      "completed": false,
      "deadline": "2026-04-16T11:00:00+03:00",
      "createdAt": "2026-04-15T14:30:00+03:00"
    }
  ],
  "meta": {
    "total": 3,
    "hasMore": false,
    "durationMs": 336
  }
}

С фильтром по диапазону дат шире 14 дней в meta дополнительно приходят autoWindowed, windowCount и batchWaves:

JSON 
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 269,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1139
  }
}

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

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

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

Ошибки

HTTP Код Описание
HTTP400 КодUNSTABLE_OFFSET_PAGINATION Описаниеoffset больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с limit до 5000, либо передайте autoWindow: false с сортировкой по id, либо режьте диапазон дат на части сами
HTTP400 КодINVALID_INCLUDE ОписаниеВ include передано имя вне набора responsible, author, editor. Ответ перечисляет доступные имена
HTTP400 КодINVALID_INCLUDE Описаниеinclude — не массив строк и не строка, например [1] или объект. Ответ имён не перечисляет
HTTP400 КодINCLUDE_LIMIT_EXCEEDED ОписаниеВ include больше трёх имён, считая повторы
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP403 КодSCOPE_DENIED ОписаниеВ include запрошена связь на сотрудника, а у ключа нет скоупа user. Ответ называет связь и недостающий скоуп
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

Известные особенности

Разбиение по временны́м окнам. Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В meta тогда приходят autoWindowed: true, число окон windowCount и число волн batchWaves. Отключает разбиение параметр autoWindow: false. При активном разбиении offset больше нуля отклоняется с UNSTABLE_OFFSET_PAGINATION.

Поля для группировки и агрегации: typeId, ownerTypeId, responsibleId, authorId, editorId, completed, status, direction, providerId, providerTypeId. Используются в POST /v1/activities/aggregate (см. Агрегация дел).

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