[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fcompanies":3,"docs-tabs-entities\u002Fcompanies":6},{"content":4,"lastmod":5},"# Компании\n\nУправление компаниями CRM: создание, получение, обновление, удаление, фильтрация.\n\nBitrix24 API: `crm.company.*`\nСкоуп: `crm`\n\n## Операции\n\n- [Создать компанию](.\u002Fcompanies\u002Fcreate.md) — `POST \u002Fv1\u002Fcompanies`\n- [Список компаний](.\u002Fcompanies\u002Flist.md) — `GET \u002Fv1\u002Fcompanies`\n- [Получить компанию](.\u002Fcompanies\u002Fget.md) — `GET \u002Fv1\u002Fcompanies\u002F:id`\n- [Обновить компанию](.\u002Fcompanies\u002Fupdate.md) — `PATCH \u002Fv1\u002Fcompanies\u002F:id`\n- [Удалить компанию](.\u002Fcompanies\u002Fdelete.md) — `DELETE \u002Fv1\u002Fcompanies\u002F:id`\n- [Поиск компаний](.\u002Fcompanies\u002Fsearch.md) — `POST \u002Fv1\u002Fcompanies\u002Fsearch`\n- [Поля компании](.\u002Fcompanies\u002Ffields.md) — `GET \u002Fv1\u002Fcompanies\u002Ffields`\n- [Агрегация компаний](.\u002Fcompanies\u002Faggregate.md) — `POST \u002Fv1\u002Fcompanies\u002Faggregate`\n","2026-06-11",{"companies\u002Fcreate.md":7,"companies\u002Flist.md":8,"companies\u002Fget.md":9,"companies\u002Fupdate.md":10,"companies\u002Fdelete.md":11,"companies\u002Fsearch.md":12,"companies\u002Ffields.md":13,"companies\u002Faggregate.md":14},"\n## Создать компанию\n\n`POST \u002Fv1\u002Fcompanies`\n\nСоздаёт новую компанию в CRM.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Описание |\n|----------|-----|---------|\n| `title` | string | Название компании |\n| `companyType` | string | Тип: `CUSTOMER`, `SUPPLIER`, `COMPETITOR`. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=COMPANY_TYPE` |\n| `industry` | string | Отрасль: `IT`, `TELECOM`, `MANUFACTURING` и др. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=INDUSTRY` |\n| `revenue` | number | Годовой оборот |\n| `currencyId` | string | Валюта оборота. Список: `GET \u002Fv1\u002Fcurrencies` |\n| `phone` | string \\| string[] \\| object[] | Телефон. Принимает три формы: строка `\"+7...\"`, массив строк `[\"+7...\", \"+7...\"]`, или массив объектов `[{ \"value\": \"+7...\", \"typeId\": \"WORK\" }, …]`. `typeId`: `WORK \\| HOME \\| MOBILE \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `email` | string \\| string[] \\| object[] | Email. Принимает три формы: строка `\"a@b.com\"`, массив строк `[\"a@b.com\", \"b@c.com\"]`, или массив объектов `[{ \"value\": \"a@b.com\", \"typeId\": \"WORK\" }, …]`. `typeId`: `WORK \\| HOME \\| MAILING \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `web` | string \\| string[] \\| object[] | Веб-сайт. Принимает три формы: строка `\"https:\u002F\u002Facme.com\"`, массив строк, или массив объектов `[{ \"value\": \"https:\u002F\u002F...\", \"typeId\": \"WORK\" }]`. `typeId`: `WORK \\| HOME \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `comments` | string | Комментарий |\n| `sourceId` | string | Источник. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=SOURCE` |\n| `sourceDescription` | string | Описание источника |\n| `assignedById` | number | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `opened` | boolean | Доступна для всех |\n| `leadId` | number | ID лида, из которого создана компания |\n\nПолный список полей: [GET \u002Fv1\u002Fcompanies\u002Ffields](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields).\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"title\": \"ООО Ромашка\",\n    \"companyType\": \"CUSTOMER\",\n    \"industry\": \"IT\",\n    \"phone\": \"+74951234567\",\n    \"email\": \"info@romashka.ru\",\n    \"web\": \"https:\u002F\u002Fromashka.ru\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"title\": \"ООО Ромашка\",\n    \"companyType\": \"CUSTOMER\",\n    \"industry\": \"IT\",\n    \"phone\": \"+74951234567\",\n    \"email\": \"info@romashka.ru\",\n    \"web\": \"https:\u002F\u002Fromashka.ru\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    title: 'ООО Ромашка',\n    companyType: 'CUSTOMER',\n    industry: 'IT',\n    phone: '+74951234567',\n    email: 'info@romashka.ru',\n    web: 'https:\u002F\u002Fromashka.ru',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Company ID:', data.id)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    title: 'ООО Ромашка',\n    companyType: 'CUSTOMER',\n    industry: 'IT',\n    phone: '+74951234567',\n    email: 'info@romashka.ru',\n    web: 'https:\u002F\u002Fromashka.ru',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### Альтернативная форма — массив объектов с явным `typeId`\n\nЕсли нужно указать несколько значений или явный тип (`HOME`, `OTHER`):\n\n```json\n{\n  \"phone\": [\n    { \"value\": \"+74951234567\", \"typeId\": \"WORK\" },\n    { \"value\": \"+74951112233\", \"typeId\": \"OTHER\" }\n  ],\n  \"email\": [\n    { \"value\": \"info@romashka.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"sales@romashka.ru\", \"typeId\": \"MAILING\" }\n  ],\n  \"web\": [\n    { \"value\": \"https:\u002F\u002Fromashka.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"https:\u002F\u002Fshop.romashka.ru\", \"typeId\": \"OTHER\" }\n  ]\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `id` | number | ID созданной компании |\n| `title` | string | Название |\n| `typeId` | string | Тип компании |\n| `industry` | string | Отрасль |\n| `assignedById` | number | Ответственный |\n| `createdBy` | number | Создатель |\n| `createdTime` | datetime | Дата создания |\n| `updatedTime` | datetime | Дата изменения |\n\nОтвет содержит все поля компании, включая пользовательские (`ufCrm_*`).\n\nURL карточки компании в Битрикс24 строится из `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Fcompany\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 2923,\n    \"title\": \"ООО Ромашка\",\n    \"typeId\": \"CUSTOMER\",\n    \"industry\": \"IT\",\n    \"revenue\": 0,\n    \"currencyId\": \"RUB\",\n    \"assignedById\": 1,\n    \"createdBy\": 1,\n    \"createdTime\": \"2026-04-15T12:53:59+03:00\",\n    \"updatedTime\": \"2026-04-15T12:53:59+03:00\",\n    \"opened\": true\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 400 | `INVALID_REQUEST` | Невалидные поля |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Список компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist)\n- [Поля компании](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Контакты](\u002Fdocs\u002Fentities\u002Fcontacts)\n- [Сделки](\u002Fdocs\u002Fentities\u002Fdeals)\n- [Entity API](\u002Fdocs\u002Fentity-api)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Список компаний\n\n`GET \u002Fv1\u002Fcompanies`\n\nВозвращает список компаний с фильтрацией, сортировкой и авто-пагинацией.\n\n## Параметры\n\n| Параметр | Тип | По умолч. | Описание |\n|----------|-----|-----------|---------|\n| `limit` | number | `50` | Количество записей (до 5000) |\n| `offset` | number | `0` | Пропустить N записей |\n| `select` | string | — | Выборка полей: `?select=id,title,phone,industry` |\n| `order` | object | — | Сортировка: `?order[title]=asc` |\n| `filter` | object | — | Фильтрация по полям `GET \u002Fv1\u002Fcompanies\u002Ffields`.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `?filter[industry]=IT` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies?limit=10&filter[industry]=IT&select=id,title,phone\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies?limit=10&filter[industry]=IT&select=id,title,phone\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies?limit=10&filter[industry]=IT', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data, meta } = await res.json()\nconsole.log(`Найдено ${meta.total} компаний`)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies?limit=10&filter[industry]=IT', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data, meta } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив компаний (поля — см. [Поля](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields)) |\n| `meta.total` | number | Общее количество записей |\n| `meta.hasMore` | boolean | Есть ещё записи |\n\nURL карточки любой компании из массива `data` — её `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Fcompany\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"title\": \"ЗАО \\\"Ложки\\\"\",\n      \"phone\": \"+15555555555\",\n      \"email\": \"info@lozzka.ru\",\n      \"assignedById\": 1,\n      \"industry\": \"IT\"\n    }\n  ],\n  \"meta\": {\n    \"total\": 1430,\n    \"hasMore\": true\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: компания с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти компанию по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](\u002Fdocs\u002Fduplicates).\n\n**Когда использовать поиск.** Для составных условий подходит `POST \u002Fv1\u002Fcompanies\u002Fsearch`. См. [Поиск компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fsearch).\n\n## Смотрите также\n\n- [Поиск компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fsearch)\n- [Создать компанию](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fcreate)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Получить компанию\n\n`GET \u002Fv1\u002Fcompanies\u002F:id`\n\nВозвращает компанию по ID. \n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID компании |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Компания:', data.title)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\nПодробнее об include: [Связанные данные](\u002Fdocs\u002Fincludes).\n\n## Поля ответа\n\nОбъект компании со всеми полями — см. [Поля компании](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields).\n\n## Связанные данные\n\n (include)\n\n```\nGET \u002Fv1\u002Fcompanies\u002F1?include=requisite\n```\n\nДоступные include: `requisite`. Результат в поле `_included`.\n\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"title\": \"ЗАО Ложки\",\n    \"industry\": \"IT\",\n    \"companyType\": \"CUSTOMER\",\n    \"assignedById\": 1,\n    \"phone\": \"+70000000001\",\n    \"phoneWork\": \"+70000000001\",\n    \"email\": \"info@example.com\",\n    \"emailWork\": \"info@example.com\",\n    \"emailHome\": \"home@example.com\",\n    \"hasPhone\": true,\n    \"hasEmail\": true,\n    \"fm\": [\n      { \"id\": 65, \"typeId\": \"PHONE\", \"valueType\": \"WORK\", \"value\": \"+70000000001\" },\n      { \"id\": 67, \"typeId\": \"EMAIL\", \"valueType\": \"WORK\", \"value\": \"info@example.com\" },\n      { \"id\": 69, \"typeId\": \"EMAIL\", \"valueType\": \"HOME\", \"value\": \"home@example.com\" }\n    ],\n    \"createdTime\": \"2020-05-08T10:48:20+03:00\",\n    \"updatedTime\": \"2025-08-22T13:01:31+03:00\"\n  }\n}\n```\n\nТелефон и почта в ответе — строки с первичным значением, значения по типам — в полях `phoneWork`, `phoneMobile`, `emailWork`, `emailHome`. Полный перечень с типами — в массиве `fm[]` (`{ id, typeId, valueType, value }`, где `id` — идентификатор записи). Наличие проверяйте по `hasPhone`\u002F`hasEmail`: при отсутствии телефона `phone` приходит пустой строкой. Отдельную запись `fm[]` по её `id` через API не изменить и не удалить — PATCH добавляет новые записи.\n\n## Пример ответа при ошибке\n\n404 — компания не найдена:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Компания не найдена |\n| 403 | `ACCESS_DENIED` | Нет доступа |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Обновить компанию](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fupdate) — изменение полей\n- [Поля компании](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields) — описание полей\n- [Контакты](\u002Fdocs\u002Fentities\u002Fcontacts) — привязаны через `companyId`\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","\n## Обновить компанию\n\n`PATCH \u002Fv1\u002Fcompanies\u002F:id`\n\nОбновляет поля компании. Передайте только изменяемые поля. Полный список в [справочнике полей](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields), включая пользовательские (`ufCrm_*`).\n\n> ⚠ **Важно про `email` \u002F `phone` \u002F `web` (multifield):** При обновлении Битрикс24 **только добавляет** новые multifield-записи. PATCH `{\"email\": \"new@y.com\"}` к компании, у которой уже есть email, **не заменит** старый — у компании станет два email. Это особенность Битрикс24, не Вайбкод. Чтобы заменить или удалить email\u002Fphone\u002Fweb — отредактируйте компанию через интерфейс Битрикс24.\n\n## Часто обновляемые поля\n\n| Параметр | Тип | Описание |\n|----------|-----|---------|\n| `title` | string | Название |\n| `phone` | string \\| string[] \\| object[] | Телефон. Принимает три формы: строка `\"+7...\"`, массив строк `[\"+7...\", \"+7...\"]`, или массив объектов `[{ \"value\": \"+7...\", \"typeId\": \"WORK\" }, …]`. `typeId`: `WORK \\| HOME \\| MOBILE \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `email` | string \\| string[] \\| object[] | Email. Принимает три формы: строка `\"a@b.com\"`, массив строк `[\"a@b.com\", \"b@c.com\"]`, или массив объектов `[{ \"value\": \"a@b.com\", \"typeId\": \"WORK\" }, …]`. `typeId`: `WORK \\| HOME \\| MAILING \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `web` | string \\| string[] \\| object[] | Веб-сайт. Принимает три формы: строка `\"https:\u002F\u002Facme.com\"`, массив строк, или массив объектов `[{ \"value\": \"https:\u002F\u002F...\", \"typeId\": \"WORK\" }]`. `typeId`: `WORK \\| HOME \\| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]` |\n| `assignedById` | number | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `industry` | string | Отрасль. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=INDUSTRY` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"title\": \"ЗАО Ложки (обновлено)\", \"industry\": \"MANUFACTURING\" }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"title\": \"ЗАО Ложки (обновлено)\", \"industry\": \"MANUFACTURING\" }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ title: 'ЗАО Ложки (обновлено)', industry: 'MANUFACTURING' }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F1', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ title: 'ЗАО Ложки (обновлено)', industry: 'MANUFACTURING' }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### Альтернативная форма — массив объектов с явным `typeId`\n\nЕсли нужно указать несколько значений или явный тип (`HOME`, `OTHER`):\n\n```json\n{\n  \"phone\": [\n    { \"value\": \"+74951234567\", \"typeId\": \"WORK\" },\n    { \"value\": \"+74951112233\", \"typeId\": \"OTHER\" }\n  ],\n  \"email\": [\n    { \"value\": \"info@romashka.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"sales@romashka.ru\", \"typeId\": \"MAILING\" }\n  ],\n  \"web\": [\n    { \"value\": \"https:\u002F\u002Fromashka.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"https:\u002F\u002Fshop.romashka.ru\", \"typeId\": \"OTHER\" }\n  ]\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | object | Обновлённый объект компании со всеми полями — см. [Поля](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields) |\n\nОбновлённый объект компании — см. [Поля компании](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields).\n\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1,\n    \"title\": \"ЗАО Ложки (обновлено)\",\n    \"industry\": \"MANUFACTURING\",\n    \"assignedById\": 1,\n    \"createdTime\": \"2020-05-08T10:48:20+03:00\",\n    \"updatedTime\": \"2026-04-15T12:00:00+03:00\"\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — компания не найдена:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Компания не найдена |\n| 403 | `ACCESS_DENIED` | Нет доступа |\n| 400 | `INVALID_REQUEST` | Невалидные поля |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Получить компанию](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fget) — текущие значения\n- [Поля компании](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields) — все поля\n- [Batch](\u002Fdocs\u002Fbatch) — массовое обновление\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","\n## Удалить компанию\n\n`DELETE \u002Fv1\u002Fcompanies\u002F:id`\n\nУдаляет компанию по ID. Восстановить удалённую компанию через API нельзя — создавайте новую при необходимости.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID компании |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F2923\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F2923\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F2923', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Компания удалена')\n}\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002F2923', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Удалено')\n}\n```\n\n## Ответ\n\nПри успешном удалении возвращается HTTP-статус `204 No Content` с пустым телом — признак успеха проверяется по статусу.\n\n## Пример ответа\n\n```\nHTTP\u002F1.1 204 No Content\n```\n\n## Пример ответа при ошибке\n\n404 — компания не найдена:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Компания не найдена |\n| 403 | `ACCESS_DENIED` | Нет доступа |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Список компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist) — найти перед удалением\n- [Batch](\u002Fdocs\u002Fbatch) — массовое удаление\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","\n## Поиск компаний\n\n`POST \u002Fv1\u002Fcompanies\u002Fsearch`\n\nПоиск компаний по условиям в теле запроса. Принимает те же фильтры, что и список компаний, и рассчитан на составные условия и большие выборки.\n\n## Поля запроса (body)\n\n| Параметр | Тип | По умолч. | Описание |\n|----------|-----|-----------|---------|\n| `filter` | object | — | Фильтрация по полям `GET \u002Fv1\u002Fcompanies\u002Ffields`.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `{ \"industry\": \"IT\" }` |\n| `limit` | number | `50` | Количество записей (до 5000) |\n| `offset` | number | `0` | Пропустить N записей |\n| `order` | object | — | Сортировка: `{ \"title\": \"asc\" }` |\n| `select` | string[] | — | Выборка полей |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"industry\": \"IT\" },\n    \"limit\": 10\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"industry\": \"IT\" },\n    \"limit\": 10\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { industry: 'IT' },\n    limit: 10,\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { industry: 'IT' },\n    limit: 10,\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив компаний (поля — см. [Поля](\u002Fdocs\u002Fentities\u002Fcompanies\u002Ffields)) |\n\nURL карточки любой компании из массива `data` — её `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Fcompany\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 1,\n      \"title\": \"ЗАО \\\"Ложки\\\"\",\n      \"industry\": \"IT\",\n      \"assignedById\": 1\n    }\n  ]\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: компания с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти компанию по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](\u002Fdocs\u002Fduplicates). Оператор `$contains` при этом работает — он ищет кусок текста внутри значения, это рабочий способ для почты: `{ \"email\": { \"$contains\": \"@example.com\" } }`.\n\n## Смотрите также\n\n- [Список компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Поля компании\n\n`GET \u002Fv1\u002Fcompanies\u002Ffields`\n\nВозвращает полный список доступных полей, включая пользовательские (`ufCrm_*`).\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | RO | Описание |\n|------|-----|:--:|---------|\n| `id` | number | да | ID компании |\n| `title` | string | | Название |\n| `companyType` | string | | Тип. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=COMPANY_TYPE` |\n| `industry` | string | | Отрасль. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=INDUSTRY` |\n| `revenue` | number | | Годовой оборот |\n| `currencyId` | string | | Валюта. Список: `GET \u002Fv1\u002Fcurrencies` |\n| `phone` | multifield | | Телефон. На вход (POST\u002FPATCH) принимает `string \\| string[] \\| object[]`. На выходе `phone` — строка с первичным значением, значения по типам — в полях `phoneWork`\u002F`phoneMobile`, полный перечень с типами — в массиве `fm[]` (формат `{ id, typeId, valueType, value }`). ⚠ PATCH **только добавляет** новые записи — старые `phone` не удаляются. См. [Обновить компанию](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fupdate). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]`. |\n| `email` | multifield | | Email. На вход принимает `string \\| string[] \\| object[]`. На выходе `email` — строка с первичным значением, значения по типам — в полях `emailWork`\u002F`emailHome`\u002F`emailMailing`, полный перечень — в массиве `fm[]`. ⚠ PATCH **только добавляет** новые записи — старые `email` не удаляются. ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]`. |\n| `web` | multifield | | Сайт. На вход принимает `string \\| string[] \\| object[]`. На выходе `web` — строка с первичным значением, значения по типам — в поле `webWork`, полный перечень — в массиве `fm[]`. ⚠ PATCH **только добавляет** новые записи — старые `web` не удаляются. ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]`. |\n| `hasPhone` | boolean | да | Указан ли телефон |\n| `hasEmail` | boolean | да | Указан ли email |\n| `hasImol` | boolean | да | Есть ли контакт в открытой линии |\n| `comments` | string | | Комментарий |\n| `sourceId` | string | | Источник. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=SOURCE` |\n| `sourceDescription` | string | | Описание источника |\n| `assignedById` | number | | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `createdBy` | number | да | Создатель. Поиск: `GET \u002Fv1\u002Fusers` |\n| `updatedBy` | number | да | Кто изменил. Поиск: `GET \u002Fv1\u002Fusers` |\n| `createdTime` | datetime | да | Дата создания |\n| `updatedTime` | datetime | да | Дата изменения |\n| `opened` | boolean | | Доступна для всех |\n| `leadId` | number | | ID лида-источника |\n\n**Пользовательские поля** (`ufCrm_*`) также возвращаются и принимаются.\n\n\n\n## Доступные include\n\nЭндпоинт `GET \u002Fv1\u002Fcompanies\u002Ffields` возвращает список доступных include: `requisite`.\n\nПример использования: [Получить companies](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fget#связанные-данные).\n\nПодробнее об include: [Связанные данные](\u002Fdocs\u002Fincludes).\n\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"fields\": {\n      \"id\": { \"type\": \"number\", \"readonly\": true, \"label\": \"ID\", \"description\": \"Идентификатор компании.\" },\n      \"title\": { \"type\": \"string\", \"readonly\": false, \"label\": \"Название\", \"description\": \"Название компании.\" },\n      \"assignedById\": { \"type\": \"number\", \"readonly\": false, \"label\": \"Ответственный\", \"description\": \"Ответственный за компанию сотрудник.\" }\n    },\n    \"batch\": [\"create\", \"update\", \"delete\"]\n  }\n}\n```\n\nПоказаны 3 из множества полей. Полный список в таблице выше. Каждое поле, помимо `type` и `readonly`, содержит `label` (человекочитаемое название) и `description` (краткое описание), локализованные: по-русски на `.tech`, по-английски на `.com`.\n\n## Пример ответа при ошибке\n\n404 — не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Создать компанию](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fcreate) — какие поля передавать\n- [Пользовательские поля](\u002Fdocs\u002Fuserfields) — `ufCrm_*`\n- [Entity API](\u002Fdocs\u002Fentity-api) — select для выборки\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","\n## Агрегация компаний\n\n`POST \u002Fv1\u002Fcompanies\u002Faggregate`\n\nПодсчёт количества, сумма, среднее, минимум и максимум по компаниям с фильтрацией и группировкой.\n\n**Стандартные поля:**\n\n- `revenue` — годовая выручка (числовое агрегирование имеет смысл)\n- `companyType` — тип компании (для `groupBy`)\n- `industry` — отрасль (для `groupBy`)\n- `assignedById` — ответственный (для `groupBy`)\n- `sourceId` — источник (для `groupBy`)\n\n**Пользовательские поля (UF):** UF-поля типов `integer`, `double`, `money` — для числовых функций; UF любого типа — для `groupBy`. Полный список UF-полей конкретного портала приходит в тексте ошибки `INVALID_PARAMS`, если передать несуществующее имя.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ \"field\": \"revenue\", \"function\": \"sum\" }`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `\"*\"`. Без массива — только `count` |\n| `filter` | object | нет | Фильтрация по полям `GET \u002Fv1\u002Fcompanies\u002Ffields`. [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5). Допустимые значения — из списка выше |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"revenue\", \"function\": \"sum\" },\n      { \"field\": \"revenue\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"companyType\": \"CUSTOMER\" },\n    \"groupBy\": \"industry\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"revenue\", \"function\": \"sum\" },\n      { \"field\": \"revenue\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"companyType\": \"CUSTOMER\" },\n    \"groupBy\": \"industry\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'revenue', function: 'sum' },\n      { field: 'revenue', function: 'avg' },\n    ],\n    filter: { companyType: 'CUSTOMER' },\n    groupBy: 'industry',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Всего компаний:', data.count)\nconsole.log('По отраслям:', data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcompanies\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'revenue', function: 'sum' },\n      { field: 'revenue', function: 'avg' },\n    ],\n    filter: { companyType: 'CUSTOMER' },\n    groupBy: 'industry',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n> Для группировки по нескольким полям передайте массив: `\"groupBy\": [\"industry\", \"companyType\"]` (максимум 5).\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }] }\n```\n\nРабота с пользовательскими полями (UF) — `sum` по UF + группировка по другому UF:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"UF_CRM_BUDGET\", \"function\": \"sum\" }],\n  \"groupBy\": \"UF_CRM_SEGMENT\"\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество записей под фильтр |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"revenue\": { \"sum\": 3000000, \"avg\": 50000 } }` |\n| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` |\n| `data.meta.totalRecords` | number | Общее количество записей под фильтр |\n| `data.meta.recordsProcessed` | number | Сколько записей обработано для числовых агрегаций (максимум 5000) |\n| `data.meta.truncated` | boolean | `true`, если под фильтр попало больше 5000 записей |\n\n## Пример ответа\n\nОтвет на основной запрос (агрегации + `groupBy: \"industry\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 60,\n    \"aggregates\": {\n      \"revenue\": { \"sum\": 3000000, \"avg\": 50000 }\n    },\n    \"groups\": [\n      {\n        \"industry\": \"IT\",\n        \"count\": 35,\n        \"aggregates\": { \"revenue\": { \"sum\": 2000000 } }\n      },\n      {\n        \"industry\": \"RETAIL\",\n        \"count\": 25,\n        \"aggregates\": { \"revenue\": { \"sum\": 1000000 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 60,\n      \"recordsProcessed\": 60,\n      \"truncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — неверное имя функции, несуществующее поле или `groupBy` по неаггрегируемому полю:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Field 'foo' not found. Available numeric fields: companyType, industry, revenue, assignedById, sourceId\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Невалидное имя функции, несуществующее поле, нечисловое поле в `sum`\u002F`avg`\u002F`min`\u002F`max`, `groupBy` по неаггрегируемому полю или больше 5 полей в `groupBy` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`count` vs числовые функции.** `count` считается одним вызовом в Битрикс24 на любом объёме данных. Функции `sum`\u002F`avg`\u002F`min`\u002F`max` подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод — если под фильтр попадает больше 5000 записей, `meta.truncated` будет `true`, агрегация выполнится по первым 5000. Для точных счётчиков на больших выборках используйте `count` или сужайте фильтр.\n\n**Money-поля.** UF-поля типа `money` хранятся в формате `\"сумма|валюта\"` (`\"1500|RUB\"`) — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.\n\n**Фильтрация по UF работает.** В `filter` можно передавать любые поля — стандартные и пользовательские, любого типа. Например, `{ \"filter\": { \"ufCrm_1234\": \"value\" } }` вернёт количество компаний с этим значением UF.\n\n## Смотрите также\n\n- [Список компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist) — получить записи с фильтрацией\n- [Поиск компаний](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fsearch) — POST-запрос с фильтрами\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n"]