метод REST scope: crm

crm.requisite.list

Получить список реквизитов по фильтру

Кто может выполнять: пользователь с правом на чтение контактов и компаний

Описание

Метод получает список реквизитов по фильтру.

Параметры

select array необязательный

Массив содержит список полей, которые необходимо выбрать (смотрите поля реквизита).

Если не передан или передан пустой массив, то будут выбраны все доступные поля реквизитов

filter object необязательный

Объект для фильтрации выбранных реквизитов в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям реквизита.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN (в качестве значения передаётся массив)
  • !@— NOT IN (в качестве значения передаётся массив)
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    - "мол%" — ищем значения, начинающиеся с «мол»
    - "%мол" — ищем значения, заканчивающиеся на «мол»
    - "%мол%" — ищем значения, где «мол» может быть в любой позиции
  • %= — LIKE (см. описание выше)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    - "мол%" — ищем значения, не начинающиеся с «мол»
    - "%мол" — ищем значения, не заканчивающиеся на «мол»
    - "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (см. описание выше)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно
order object необязательный

Объект для сортировки выбранных реквизитов в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям реквизита.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания
start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list

Ответ

HTTP-статус: 200

{
"result": [
    {
    "ENTITY_TYPE_ID": "4",
    "ENTITY_ID": "3027",
    "ID": "40",
    "NAME": "Организация"
    },
    {
    "ENTITY_TYPE_ID": "4",
    "ENTITY_ID": "3028",
    "ID": "41",
    "NAME": "Реквизиты головного офиса"
    },
    {
    "ENTITY_TYPE_ID": "4",
    "ENTITY_ID": "3028",
    "ID": "42",
    "NAME": "Филиал в г. Черняховск"
    }
],
"total": 3,
"time": {
    "start": 1717150154.197056,
    "finish": 1717150154.505106,
    "duration": 0.30804991722106934,
    "processing": 0.030454158782958984,
    "date_start": "2024-05-31T12:09:14+02:00",
    "date_finish": "2024-05-31T12:09:14+02:00",
    "operating": 0
}
}

Возвращаемые данные

result array

Массив объектов с информацией из выбранных реквизитов. Каждый элемент содержит выбранные поля реквизита

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Access denied."
}
Код Описание Значение
0 Access denied. Недостаточно прав доступа для получения списка реквизитов

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.