#Поиск сделок

POST /v1/deals/search

Поиск сделок с фильтрами и авто-пагинацией. Аналогичен GET /v1/deals с фильтрами, но через POST — удобнее для сложных запросов с большим количеством условий.

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

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

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "stageId": "NEW" },
    "limit": 10,
    "order": { "amount": "desc" }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "stageId": "NEW" },
    "limit": 10,
    "order": { "amount": "desc" }
  }'

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

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

const { success, data } = await res.json()
console.log('Найдено:', data.length)

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

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

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

#Поля ответа

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3865,
      "title": "Шаблончик",
      "amount": 0,
      "currency": "RUB",
      "stageId": "NEW",
      "categoryId": 0,
      "assignedById": 29,
      "createdAt": "2021-01-13T13:52:44.000Z"
    }
  ]
}

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

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

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