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

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 Название
companyType string Тип. Список: GET /v1/statuses?filter[entityId]=COMPANY_TYPE
industry string Отрасль. Список: GET /v1/statuses?filter[entityId]=INDUSTRY
revenue number Годовой оборот
currencyId string Валюта. Список: GET /v1/currencies
phone string Телефон
email string Email
web string Сайт
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 лида-источника

Пользовательские поля (ufCrm_*) также возвращаются и принимаются.

#Доступные include

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

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

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

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

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 — Ошибки.

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