#Список компаний

GET /v1/companies

Возвращает список компаний с фильтрацией, сортировкой и авто-пагинацией.

#Параметры

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

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/companies?limit=10&filter[industry]=IT&select=id,title,phone" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/companies?limit=10&filter[industry]=IT&select=id,title,phone" \
  -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?limit=10&filter[industry]=IT', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} компаний`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/companies?limit=10&filter[industry]=IT', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Поле Тип Описание
data array Массив компаний (поля — см. Поля)
meta.total number Общее количество записей
meta.hasMore boolean Есть ещё записи

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "ЗАО \"Ложки\"",
      "phone": "+15555555555",
      "email": "info@lozzka.ru",
      "assignedById": 1,
      "industry": "IT"
    }
  ],
  "meta": {
    "total": 1430,
    "hasMore": true
  }
}

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

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

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

Когда использовать search: для сложных фильтров удобнее POST /v1/companies/search. См. Поиск компаний.

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