метод REST scope: crm

crm.category.get

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

Кто может выполнять: любой пользователь с правом доступа к воронке «Чтение»

Описание

Метод получает информацию о воронке (направлении) с идентификатором id.

Параметры

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

Идентификатор системного или пользовательского типа объекта CRM у которого мы желаем получить воронку

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

Идентификатор воронки. Можно получить методом crm.category.list или при создании воронки методом crm.category.add

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "category": {
            "id": 1,
            "name": "Новая воронка #1",
            "sort": 200,
            "entityTypeId": 2,
            "isDefault": "N",
            "originId": "",
            "originatorId": ""
        }
    },
    "time": {
        "start": 1718291429.253404,
        "finish": 1718291429.654617,
        "duration": 0.4012131690979004,
        "processing": 0.025265216827392578,
        "date_start": "2024-06-13T17:10:29+02:00",
        "date_finish": "2024-06-13T17:10:29+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа. Содержит объект category

time time

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

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

HTTP-статус: 400

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

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

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