06.04.2026 22:45

Get

[POST] .../v1/deal/get

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

Входные параметры

Название Тип данных Обязательность Описание
ids Array of Int64 Необязательный Фильтр по ID сделок
client_ids Array of Int64 Необязательный Фильтр по связанным клиентам
task_ids Array of Int64 Необязательный Фильтр по связанным задачам проекта
lead_ids Array of Int64 Необязательный Фильтр по связанным обращениям
responsible_user_ids Array of Int64 Необязательный Фильтр по ответственным
stage_ids Array of Int64 Необязательный Фильтр по стадиям
pipeline_id Int64 Необязательный Фильтр по воронке
currency_id Int64 Необязательный Фильтр по валюте сделки
filters Array of Filter Необязательный Дополнительные фильтры по основным и пользовательским полям
limit Int32 Необязательный Лимит выборки, при <= 0 используется 100, максимум 1000
offset Int32 Необязательный Смещение выборки, при < 0 используется 0

Стандартные поля для фильтрации (filters)

lead_id, task_id, deal_type_id, pipeline_id, responsible_user_id, stage_id, status,
currency_id, title, amount, open_date, close_date

Пример запроса

{
  "client_ids": [501],
  "responsible_user_ids": [15],
  "pipeline_id": 8,
  "stage_ids": [31],
  "limit": 50,
  "offset": 0
}

Выходные параметры

Название Тип данных Описание
result Array of Deal Массив сделок
next_offset Int32 Смещение для следующей страницы
total Int64 Общее количество записей

Модель Deal включает:

  • client_id и вложенный client;
  • fields — значения дополнительных полей (см. Field);
  • chat_id — ID связанного чата (см. Chat и ChatMessage).

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

{
  "ok": true,
  "result": [
    {
      "id": 220,
      "client_id": 501,
      "task_id": 845,
      "client": {
        "id": 501,
        "name": "Иван",
        "phone": "+998901234567"
      },
      "lead_id": 105,
      "ticket_id": 9001,
      "source_deal_id": null,
      "deal_type_id": null,
      "pipeline_id": 8,
      "stage_id": 31,
      "title": "Сделка по заявке #105",
      "description": null,
      "amount": 2500.00,
      "currency": {
        "id": 1,
        "code_num": 840,
        "code_chr": "USD",
        "name": "Доллар США"
      },
      "responsible_user_id": 15,
      "participant_user_ids": [15, 18],
      "open_date": 1773138600,
      "close_date": null,
      "created_user_id": 1,
      "last_update": 1773138600,
      "chat_id": "b4fc6b6c-e2f6-4f43-bf80-8ae329d5d3b1",
      "fields": []
    }
  ],
  "next_offset": 50,
  "total": 1
}