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

Список дел

GET /v1/activities

Возвращает список CRM-дел с поддержкой фильтрации, сортировки и авто-пагинации. Фильтр по ownerId + ownerTypeId возвращает дела конкретной сделки, лида или контакта.

Параметры

Параметр Тип По умолч. Описание
Параметрlimit Типnumber По умолч.50 ОписаниеКоличество записей (до 5000). При limit > 50 авто-пагинация
Параметрoffset Типnumber По умолч.0 ОписаниеПропустить N записей. При offset > 0 рекомендуется limit ≤ 500
Параметрselect Типstring По умолч.— ОписаниеВыборка полей: ?select=id,subject,typeId,completed
Параметрsort Типstring По умолч.— ОписаниеСортировка кратким синтаксисом: ?sort=-deadline, минус означает убывание
Параметрorder Типobject По умолч.— ОписаниеСортировка: ?order[deadline]=asc
Параметрfilter Типobject По умолч.— ОписаниеФильтрация по полям GET /v1/activities/fields.
Синтаксис фильтрации. Пример: ?filter[ownerTypeId]=2&filter[ownerId]=741
Параметрinclude Типstring По умолч.— ОписаниеСвязанные сотрудники через запятую: responsible, author, editor. Подробнее — секция «Связанные данные» ниже

Примеры

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/activities?filter[ownerTypeId]=2&filter[ownerId]=741&limit=10&select=id,subject,typeId,completed" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/activities?filter[ownerTypeId]=2&filter[ownerId]=741&limit=10&select=id,subject,typeId,completed" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities?filter[ownerTypeId]=2&filter[ownerId]=741&limit=10&select=id,subject,typeId,completed', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities?filter[ownerTypeId]=2&filter[ownerId]=741&limit=10&select=id,subject,typeId,completed', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

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

Связанные данные

Получить сотрудников, связанных с делами, вместе со списком — параметр include в GET-запросе:

GET /v1/activities?filter[ownerTypeId]=3&filter[ownerId]=409&include=responsible,author

Доступные значения include — до трёх имён за запрос:

Имя По какому полю Ключ в _included Результат
Имяresponsible По какому полюresponsibleId — ответственный Ключ в _includedresponsible РезультатКарточка сотрудника или null
Имяauthor По какому полюauthorId — автор Ключ в _includedauthor РезультатКарточка сотрудника или null
Имяeditor По какому полюeditorId — последний редактор Ключ в _includededitor РезультатКарточка сотрудника или null

Карточка сотрудника та же, что в ответе GET /v1/users/:id. Связь читает сотрудника, поэтому ключу кроме crm нужен скоуп user. Результат — в поле _included каждого элемента data:

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1111,
      "subject": "Коммерческое предложение",
      "ownerTypeId": 3,
      "ownerId": 409,
      "responsibleId": 29,
      "authorId": 1,
      "_included": {
        "responsible": { "id": 29, "name": "Анна", "lastName": "Смирнова", "email": "anna.smirnova@example.com", "active": false },
        "author": { "id": 1, "name": "Иван", "lastName": "Петров", "email": "ivan.petrov@example.com", "active": true }
      }
    }
  ],
  "meta": { "total": 1, "hasMore": false }
}

Показаны основные поля дела и сотрудника. Полный состав карточки — Поля сотрудника. Если в ответе больше 200 записей, связи не загружаются, а в meta приходит includeSkipped: true — уменьшите limit.

Поля responsibleId, authorId, editorId необязательно указывать в select: карточка придёт и без них, а сами поля в ответ не добавятся.

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

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

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

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

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_INCLUDE ОписаниеВ include передано имя вне набора responsible, author, editor. Ответ перечисляет доступные имена
HTTP400 КодINVALID_INCLUDE Описаниеinclude передан не строкой имён через запятую, например include[a]=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 — Ошибки.

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

Авто-пагинация: при limit > 50 Вайбкод автоматически запрашивает несколько страниц.

Фильтр по сущности: для получения дел конкретной сделки используйте filter[ownerTypeId]=2&filter[ownerId]=741. Значения ownerTypeId: 1 — лид, 2 — сделка, 3 — контакт, 4 — компания.

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

Дела без срока: у дел без установленного deadline поле возвращается со значением-заглушкой 9999-12-30T21:00:00.000Z — не реальная дата. Фильтр по меньшей дате, например filter[<deadline]=2027-01-01T00:00:00, такие дела не выбирает, поэтому в выборку просроченных они не попадают.

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