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

Поля компании

GET /v1/companies/fields

Возвращает полный список доступных полей, включая пользовательские (ufCrm_*).

Примеры

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

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

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

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

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

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

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

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

Поля ответа

Поле Тип RO Описание
id number да ID компании
title string Название
typeId string Тип компании: CUSTOMER, SUPPLIER, COMPETITOR. Список значений: GET /v1/statuses?filter[entityId]=COMPANY_TYPE
industry string Отрасль. Список: GET /v1/statuses?filter[entityId]=INDUSTRY
revenue number Годовой оборот
currencyId string Валюта. Список: GET /v1/currencies
phone multifield Телефон. На вход (POST/PATCH) принимает string | string[] | object[]. На выходе phone — строка с первичным значением, значения по типам — в полях phoneWork/phoneMobile, полный перечень с типами — в массиве fm[] (формат { id, typeId, valueType, value }). ⚠ PATCH только добавляет новые записи — старые phone не удаляются. См. Обновить компанию. ⚠ UPPER-форма [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] не принимается — вернёт 400 INVALID_MULTIFIELD_SHAPE. Используйте camelCase: [{ "value": "...", "typeId": "WORK" }].
email multifield Email. На вход принимает string | string[] | object[]. На выходе email — строка с первичным значением, значения по типам — в полях emailWork/emailHome/emailMailing, полный перечень — в массиве fm[]. ⚠ PATCH только добавляет новые записи — старые email не удаляются. ⚠ UPPER-форма [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] не принимается — вернёт 400 INVALID_MULTIFIELD_SHAPE. Используйте camelCase: [{ "value": "...", "typeId": "WORK" }].
web multifield Сайт. На вход принимает string | string[] | object[]. На выходе web — строка с первичным значением, значения по типам — в поле webWork, полный перечень — в массиве fm[]. ⚠ PATCH только добавляет новые записи — старые web не удаляются. ⚠ UPPER-форма [{ "VALUE": "...", "VALUE_TYPE": "WORK" }] не принимается — вернёт 400 INVALID_MULTIFIELD_SHAPE. Используйте camelCase: [{ "value": "...", "typeId": "WORK" }].
hasPhone boolean да Указан ли телефон
hasEmail boolean да Указан ли email
hasImol boolean да Есть ли контакт в открытой линии
comments string Комментарий
sourceId string Источник. Список: GET /v1/statuses?filter[entityId]=SOURCE
sourceDescription string Описание источника
assignedById number Ответственный. Список: GET /v1/users
createdBy number да Создатель. Поиск: GET /v1/users
updatedBy number да Кто изменил. Поиск: GET /v1/users
createdTime datetime да Дата создания
updatedTime datetime да Дата изменения
opened boolean Доступна для всех
leadId number ID лида-источника
entityTypeId number да ID типа CRM-сущности; у компании всегда 4
emailWork string | null да Рабочий e-mail из мультиполя email. Записывается через email
emailHome string | null да Личный e-mail из мультиполя email. Записывается через email
emailMailing string | null да E-mail для рассылок из мультиполя email. Записывается через email
phoneWork string | null да Рабочий телефон из мультиполя phone. Записывается через phone
phoneMobile string | null да Мобильный телефон из мультиполя phone. Записывается через phone
phoneMailing string | null да Телефон для рассылок из мультиполя phone. Записывается через phone
imol string | null да Контакт в открытой линии из коллекции мультиполей
address string | null да Фактический адрес одной строкой. Правится в реквизитах компании
addressLegal string | null да Юридический адрес одной строкой. Правится в реквизитах компании
searchContent string | null да Служебное поле. Строка, которую Битрикс24 склеивает из текста карточки для своего полнотекстового поиска. Фильтр по ней принимается, но опираться на него не стоит: состав может меняться без предупреждения. Показывать человеку тоже не следует

Одиннадцать полей выше приходят в данных list/get, но записать их напрямую нельзя: Битрикс24 отвечает успехом и значение не сохраняет, поэтому платформа отклоняет их с 400 READONLY_FIELD. Адреса правятся в реквизитах компании, телефоны и адреса e-mail — через мультиполя phone и email.

Пользовательские поля (ufCrm_*) также возвращаются и принимаются. Набор таких полей свой на каждом портале, поэтому в статическую схему они не входят — их описания приходят от Битрикс24.

Доступные include

Эндпоинт GET /v1/companies/fields возвращает список доступных include: requisite.

Пример использования: Получить companies.

Подробнее об include: Связанные данные.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Идентификатор компании." },
      "title": { "type": "string", "readonly": false, "label": "Название", "description": "Название компании." },
      "assignedById": { "type": "number", "readonly": false, "label": "Ответственный", "description": "Ответственный за компанию сотрудник." }
    },
    "batch": ["create", "update", "delete"]
  }
}

Показаны 3 из множества полей. Полный список в таблице выше. Каждое поле, помимо type и readonly, содержит label (понятное человеку название) и description (краткое описание) на русском языке, а подписи, которые платформа берёт напрямую с портала, — на языке портала. Заголовками запроса язык не переключается.

Ошибки

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

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

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