Особенности списочных методов

В REST API существует ряд методов, которые возвращают списки элементов — списки сделок, пользователей, комментариев к задаче и т.д.

Поскольку количество возвращаемых элементов зависит от конкретных условий и параметров, то Битрикс24 возвращает их «пакетами» по несколько элементов (в настоящий момент не более, чем по 50).

Пример:

        https://your-domain.bitrix24.com/rest/crm.item.list?entityTypeId=183&auth=d161f25928c3184678924ec127edd29a
        
        //получить в формате json список всех элементов пользовательского типа CRM с идентификатором 183.
        
        

При вызове списочных методов REST возвращает дополнительные значения в ответе:

{
            "result": результат выполнения метода,
            "error": ошибка выполнения метода,
            "total": общее количество записей в ответе списочного метода,
            "next": значение, которое нужно послать для получение следующей страницы данных списочного метода
        }
        

Для получения следующего пакета элементов, необходимо выполнить тот же самый запрос, указав дополнительный параметр start со значением, пришедшем в параметре next ответа. При использовании SDK BX24.js, получение очередного пакета делается с помощью метода result.next().

Выполнение списочных методов может оказаться достаточно «тяжелым» с точки зрения производительности Битрикс24, поскольку объем обрабатываемых данных может оказаться очень большим. Чтобы ваши приложения не выходили за рамки лимитов REST API, рекомендуем ознакомиться со статьей.