#Поля дела

GET /v1/activities/fields

Возвращает полный список доступных полей дела.

#Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data).length)

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

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

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

#Поля ответа

Поле Тип RO Описание
id number да ID дела
typeId number Тип: 1 — звонок, 2 — встреча, 3 — задача, 6 — email
ownerTypeId number Тип родительской сущности: 1 — лид, 2 — сделка, 3 — контакт, 4 — компания
ownerId number ID родительской сущности. Поиск зависит от ownerTypeId: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies
associatedEntityId number да ID связанной сущности (звонок/письмо/встреча в b24-модуле). Заполняется автоматически после создания дела соответствующим провайдером
subject string Тема дела
description string Описание
descriptionType number Тип описания: 1 — plain text, 3 — BBCode/HTML
responsibleId number Ответственный. Список: GET /v1/users
authorId number да Автор записи. Заполняется b24 на основании текущего пользователя при создании
editorId number да Последний редактор. Обновляется b24 при каждом изменении
priority number Приоритет: 1 — низкий, 2 — средний, 3 — высокий
direction number Направление: 1 — входящее, 2 — исходящее
location string Место проведения (для встреч)
completed boolean Завершена
status number Статус дела: 1 — ожидание, 2 — в процессе, 3 — выполнено
startTime datetime Дата начала
endTime datetime Дата окончания
deadline datetime Крайний срок
createdAt datetime да Дата создания
updatedAt datetime да Дата изменения
notifyType number Тип напоминания: 0 — выкл., 1 — за минуты, 2 — за часы, 3 — за дни
notifyValue number Значение напоминания (в единицах из notifyType)
providerId string ID провайдера дела (CRM_CALL_LIST, IMOL, CRM_REQUEST и т.п.)
providerTypeId string Подтип провайдера (зависит от providerId)
providerGroupId string Идентификатор группы провайдера (например, по треду e-mail)
providerParams object Произвольные параметры провайдера (структура зависит от providerId)
providerData string Сериализованные данные провайдера (XML/JSON в строке)
settings object Дополнительные настройки дела (структура зависит от typeId и providerId)
originId string Внешний ID, если дело пришло из стороннего канала (CTI, email)
originatorId string ID источника-инициатора (приложение/коннектор)
resultStatus number Статус результата дела (числовой код)
resultStream number Поток обработки результата
resultSourceId string Источник результата
resultMark number Оценка/маркер результата
resultValue number Численное значение результата
resultSum number Сумма по результату (например, чек)
resultCurrencyId string Валюта результата (RUB, USD, …)
autocompleteRule number Правило автозавершения дела (числовой код)
isIncomingChannel boolean да Дело пришло из входящего канала (open-line/звонок/письмо). Только чтение

#Значения typeId

Значение Тип дела
1 Звонок
2 Встреча
3 Задача
6 Email

#Значения ownerTypeId

Значение Родительская сущность Поиск
1 Лид GET /v1/leads
2 Сделка GET /v1/deals
3 Контакт GET /v1/contacts
4 Компания GET /v1/companies

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "integer", "isRequired": false, "isReadOnly": true, "title": "ID" },
      "title": { "type": "string", "isRequired": false, "isReadOnly": false, "title": "Название" },
      "assignedById": { "type": "integer", "isRequired": false, "isReadOnly": false, "title": "Ответственный" }
    }
  }
}

Показаны 3 из множества полей. Полный список в таблице выше.

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

404 — не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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