Реализуемый метод API

GET /api/v4/leads/{id}

Официальная докуметация метода

Описание

Метод позволяет получить данные конкретной сделки по ID.

Ограничения

Метод доступен в соответствии с правами пользователя.

Параметры

Различия

В документации метода AmoCRM сообщается о возможном необязательном параметре $with. На данный момент библиотека WT Amocrm его не поддерживает.

Возвращаемые значения

HTTP 200 Успешный ответ

Возвращаемое значение соответствует документации AmoCRM для этого метода.

Пример ответа

stdClass Object
(
    [id] => 20456399
    [name] => Заказ с сайта № 00000041
    [price] => 20205
    [responsible_user_id] => 6520033
    [group_id] => 0
    [status_id] => 36335095
    [pipeline_id] => 3753682
    [loss_reason_id] => 
    [created_by] => 0
    [updated_by] => 0
    [created_at] => 1673632365
    [updated_at] => 1673632365
    [closed_at] => 
    [closest_task_at] => 
    [is_deleted] => 
    [custom_fields_values] => Array
        (
            [0] => stdClass Object
                (
                    [field_id] => 870735
                    [field_name] => Комментарий
                    [field_code] => 
                    [field_type] => text
                    [values] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [value] => 00000041 afasdfasdfasdf Sergey Саратов 1000 1000 +79063049783
                                )

                        )

                    [is_computed] => 
                )

            [1] => stdClass Object
                (
                    [field_id] => 870737
                    [field_name] => теест
                    [field_code] => 
                    [field_type] => textarea
                    [values] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [value] => 20205.0000 Sergey
                                )

                        )

                    [is_computed] => 
                )

            [2] => stdClass Object
                (
                    [field_id] => 776255
                    [field_name] => _ym_uid
                    [field_code] => _YM_UID
                    [field_type] => tracking_data
                    [values] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [value] => 1652458799256106622
                                )

                        )

                    [is_computed] => 
                )

        )

    [score] => 
    [account_id] => 29145994
    [labor_cost] => 0
    [is_price_computed] => 
    [_links] => stdClass Object
        (
            [self] => stdClass Object
                (
                    [href] => https://yoursubdomain.amocrm.ru/api/v4/leads/20456399?page=1&limit=50
                )

        )

    [_embedded] => stdClass Object
        (
            [tags] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 221689
                            [name] => тест 2 
                            [color] => 
                        )

                )

            [companies] => Array
                (
                )

        )

)

HTTP 40x Неудачный ответ

Официальная документация говорит о возможном коде ответа 401 Пользователь не авторизован. Библиотека WT Amocrm возвращает объект ошибки следующей структуры:

stdClass Object
(
    [error_code] => 401
    [error_message] => getleadById function: Error while trying to get lead details from Amo CRM. Amo CRM API response: error detail from API
)

Пример использования в коде

use Webtolk\Amocrm\Amocrm;

$amocrm = new Amocrm();
// Lead id
$id = 204563912;
$lead = $amocrm->getLeadById($id);
$lead_name = $lead->name;
$lead_price = $lead->price;