К содержанию
База CRMДокументация

API v1

Фильтры и сортировка

Фильтр передаётся как дерево условий — то же дерево, которое строит конструктор фильтров в интерфейсе.

Фильтр передаётся как дерево условий — то же дерево, которое строит конструктор фильтров в интерфейсе.

#Форма фильтра

json
{
  "conj": "and",
  "rules": [
    { "fieldId": "9e…text-field", "op": "contains", "value": "Acme" },
    { "conj": "or",
      "rules": [
        { "fieldId": "9e…number-field", "op": "gte", "value": 1000 },
        { "fieldId": "__stage", "op": "is", "value": "9e…stage-uuid" }
      ] }
  ]
}
  • Группы можно вкладывать не глубже одного уровня.
  • __stage — специальное поле для фильтра по этапу.
  • Опустите фильтр — вернутся все записи коллекции.

#Операторы по типам полей

  • Текст — contains, ncontains, eq, empty, nempty.
  • Число / Валюта — eq, ne, gt, lt, gte, lte, empty, nempty.
  • Дата / Дата и время — on, before, after, empty, nempty.
  • Выбор / Связь / Сотрудник — is, isnot, has, hasnot, empty, nempty.
  • Чекбокс — checked, unchecked.
  • Этап — is, isnot.

#Сортировка

json
{ "sort": { "fieldId": "__stage", "dir": "asc" } }
  • fieldId — __title, __stage или идентификатор поля.
  • dir — asc (по умолчанию) или desc.
  • Без сортировки записи идут в порядке position.