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

Получить дело

GET /v1/activities/:id

Возвращает дело по ID.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID дела. Список: GET /v1/activities
Параметрselect (query) Типstring Обяз.нет ОписаниеПоля ответа через запятую, например id,subject. Без параметра приходят все поля. Имена — из Поля дела
Параметрinclude (query) Типstring Обяз.нет ОписаниеСвязанные сотрудники через запятую: responsible, author, editor. Подробнее — секция «Связанные данные» ниже

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/activities/3894" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

const { success, data } = await res.json()
console.log('Дело:', data.subject, '— завершено:', data.completed)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном запросе
Полеdata Типobject ОписаниеДело со всеми полями. Все поля — Поля дела
Полеdata._included Типobject ОписаниеСвязанные сотрудники. Приходит только при параметре include — секция «Связанные данные»

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

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

GET /v1/activities/1111?include=responsible,author

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

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

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

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 }
    }
  }
}

Показаны основные поля дела и сотрудника. Полный состав карточки — Поля сотрудника.

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

Показаны основные поля. Полный список: Поля дела.

JSON 
{
  "success": true,
  "data": {
    "id": 3894,
    "typeId": 1,
    "ownerTypeId": 3,
    "ownerId": 17,
    "subject": "Встреча по проекту",
    "description": "Обсуждение условий поставки\n\nОтправлено из «Битрикс24»",
    "responsibleId": 1,
    "priority": 2,
    "direction": 2,
    "completed": false,
    "startTime": "2026-10-21T07:00:00.000Z",
    "endTime": "2026-10-21T08:00:00.000Z",
    "deadline": "2026-10-21T07:00:00.000Z",
    "createdAt": "2026-10-19T12:08:24.000Z",
    "updatedAt": "2026-10-19T12:08:24.000Z"
  }
}

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

404 — дело не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Activity is not found."
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеДело с таким ID не найдено
HTTP400 КодINVALID_PARAMS Описаниеid не целое неотрицательное число. Сообщение: id must be a non-negative integer
HTTP400 КодUNKNOWN_SELECT_FIELD ОписаниеВ select передано неизвестное поле. Сообщение перечисляет допустимые имена
HTTP400 КодINVALID_INCLUDE ОписаниеВ include передано имя вне набора responsible, author, editor. Ответ перечисляет доступные имена
HTTP400 КодINVALID_INCLUDE Описаниеinclude передан не строкой имён через запятую, например include[a]=1. Ответ имён не перечисляет
HTTP400 КодINCLUDE_LIMIT_EXCEEDED ОписаниеВ include больше трёх имён, считая повторы
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя ключа нет прав на это дело в Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP403 КодSCOPE_DENIED ОписаниеВ include запрошена связь на сотрудника, а у ключа нет скоупа user. Ответ называет связь и недостающий скоуп
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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