метод REST scope: crm

crm.category.list

Получить список воронок

Кто может выполнять: любой пользователь

Описание

Метод получает список воронок (направлений), которые относятся к типу объекта CRM с идентификатором entityTypeId.

Какие воронки попадут в список

Список отдаваемых воронок фильтруется по правам доступа. Это значит, что если у пользователя нет прав для чтения определенной воронки, она не попадет в ответ.

Параметры

entityTypeId integer обязательный

Идентификатор системного или пользовательского типа сущностей CRM, для которого нужно получить список воронок

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.list

Ответ

HTTP-статус: 200

{
    "result": {
        "categories": [
            {
                "id": 9,
                "name": "Воронка с оригинальным названием",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 10,
                "name": "Лидовый маршрут",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 11,
                "name": "Путь успеха",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 0,
                "name": "Общая",
                "sort": 300,
                "entityTypeId": 2,
                "isDefault": "Y"
            }
        ]
    },
    "total": 4,
    "time": {
        "start": 1718293410.373042,
        "finish": 1718293425.947633,
        "duration": 15.574590921401978,
        "processing": 15.16909408569336,
        "date_start": "2024-06-13T17:43:30+02:00",
        "date_finish": "2024-06-13T17:43:45+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа. Содержит единственный элемент с ключом categories, который представляет собой массив воронок. Структура отдельно взятой воронки соответсвует объекту category

total integer

Общее количество воронок, принадлежащих определенному entityTypeId

time time

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

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

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Смарт-процесс не найден"
}
Код Описание Значение
NOT_FOUND Смарт-процесс не найден Возникает, при некорректных значениях entityTypeId
ENTITY_TYPE_NOT_SUPPORTED Entity type {entityTypeName} is not supported Возникает, если объект CRM не поддерживает воронки

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

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