Метод призначений для отримання списку Підписників. Може використовуватися для пошуку за визначеним набором фільтрів. Усі параметри є необов’язковими. Дані передаються в 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 містить масив підписників.