#Поля дела

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
subject string Тема дела
description string Описание
responsibleId number Ответственный. Список: GET /v1/users
priority number Приоритет: 1 — низкий, 2 — средний, 3 — высокий
direction number Направление: 1 — входящее, 2 — исходящее
completed boolean Завершена
startTime datetime Дата начала
endTime datetime Дата окончания
deadline datetime Крайний срок
createdAt datetime да Дата создания
updatedAt datetime да Дата изменения

#Значения 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 — Ошибки.

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