Поиск компаний

POST /v1/companies/search

Поиск компаний по условиям в теле запроса. Принимает те же фильтры, что и список компаний, и рассчитан на составные условия и большие выборки.

Поля запроса (body)

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/companies/fields.
Синтаксис фильтрации. Пример: { "industry": "IT" }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
order object — Сортировка: { "title": "asc" }
select string[] — Выборка полей

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/companies/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "industry": "IT" },
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/companies/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "industry": "IT" },
    "limit": 10
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/companies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { industry: 'IT' },
    limit: 10,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/companies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { industry: 'IT' },
    limit: 10,
  }),
})

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

Поля ответа

Поле Тип Описание
data array Массив компаний (поля — см. Поля)

URL карточки любой компании из массива data — её id:

https://<portal>.bitrix24.ru/crm/company/details/<id>/

<portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "ЗАО \"Ложки\"",
      "industry": "IT",
      "assignedById": 1
    }
  ]
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

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

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

Известные особенности

Фильтр по телефону подходит не для всякого поиска. Значение без оператора сравнивается со всей сохранённой строкой: компания с номером +7 (999) 123-45-67 найдётся по этой же строке и не найдётся по 79991234567, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти компанию по номеру телефона в любом написании и по любому из его номеров, используйте Поиск дубликатов. Оператор $contains при этом работает — он ищет кусок текста внутри значения, это рабочий способ для почты: { "email": { "$contains": "@example.com" } }.

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