Подписчики сущности

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

Список подписчиков сущности

Метод

GET /api/v4/leads/{id}/subscriptions

GET /api/v4/customers/{id}/subscriptions

Описание

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

Ограничения

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

GET параметры

Параметр	Тип данных	Описание
page	int	Страница выборки
limit	int	Количество возвращаемых сущностей за один запрос (Максимум – 250)

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
204	Данных не найдено
401	Пользователь не авторизован
402	Аккаунт не оплачен
403	Недостаточно прав
404	Сущность не найдена

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

Метод возвращает коллекцию моделей подписчиков сущности, рассмотрим ниже свойства подписчиков.

Параметр	Тип данных	Описание
subscriber_id	int	ID подписчика
type	string	Тип подписчика – пользователь или группа (user, group)

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

{
    "_total_items": 2,
    "_page": 1,
    "_page_count": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/667999637/subscriptions?page=1&limit=50"
        }
    },
    "_embedded": {
        "subscriptions": [
            {
                "subscriber_id": 964291,
                "type": "user"
            },
            {
                "subscriber_id": 1150,
                "type": "group"
            }
        ]
    }
}

Оглавление