Метод предназначен для получения списка Подписчиков. Можно использовать для поиска по определённому набору фильтров. Все параметры не обязательные. Данные передаются в query параметрах в ссылке
HTTP запрос
- URL:
https://sender-solutions.com/api/subscribers/subscribers-list/ - HTTP Метод: GET
Пример запроса с максимальным набором параметров с использованием cURL
curl --location 'https://sender-solutions.com/api/subscribers/subscribers-list/?offset=0&limit=10&Id=25&BaseId=13&ClientUserId=ClientUserId12345&Email=username%40example.com&IsActive=1&FirstName=Cat&LastName=Catstone&Gender=male' \
--header 'Authorization: {{api-token}}'
Описание полей
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
offset | int | Количество найденных подписчиков из итогового списка, которых необходимо пропустить. Необходимо для возможности порционного (постраничного) чтения данных. По умолчанию 0 | |
limit | int | Максимальное количество подписчиков, которых необходимо отобразить в ответ на этот запрос. Необходимо для возможности порционного (постраничного) чтения данных. По умолчанию 50, максимум 1000 | |
Id | int | Идентификатор подписчика. Если указан, работает как фильтр | |
BaseId | int | Идентификатор Базы подписчиков. Если указан, работает как фильтр | |
ClientUserId | string | ID подписчика в системе клиента. Если указан, работает как фильтр | |
Email | string | Email подписчика. Если указан, работает как фильтр | |
IsActive | int | Флаг активности подписчика. Если указан, работает как фильтр. Укажите 0 для поиска неактивных подписчиков, и 1 для активных | |
FirstName | string | Имя подписчика. Если указан, работает как фильтр | |
LastName | string | Фамилия подписчика. Если указан, работает как фильтр | |
Gender | string | Пол подписчика. Если указан, работает как фильтр. Возможные значения: "male" для мужского, "female" для женского, пустая строка для значения "Не указано". |
Пример успешного ответа в JSON
{
"TotalCount": 1,
"Offset": 0,
"Limit": 10,
"Subscribers": [
{
"Id": 25,
"Base": {
"Id": 13,
"Name": "Test Users"
},
"IsActive": true,
"Email": "username@example.com",
"FirstName": "Cat",
"LastLame": "Catstone",
"Gender": "male",
"Phone": "+380111222333",
"Tags": [
"api",
"test-user"
],
"ClientUserId": "ClientUserId12345",
"CustomField1": "CustomValue1",
"CustomField2": "CustomValue2",
"CustomField3": "CustomValue3",
"Address": {
"Country": "UA",
"City": "Odesa",
"State": "",
"Zip": "65000",
"Line1": "Very Long street",
"Line2": "building 42",
"Line3": ""
},
"Birthday": "2002-04-15"
}
]
}В этом ответе поле TotalCount означает общее количество подписчиков, найденых по запросу. Поля Offset и Limit дублируют значения из запроса, с учётом ограничений по минимальным и максимальным значениям. Поле Subscribers содержит массив подписчиков.