1. Nápověda
  2. Jak pracovat přes API s sender-solutions.com
  3. 5. Získání seznamu odběratelů přes API

5. Získání seznamu odběratelů přes API

5. Získání seznamu odběratelů přes API

Metoda je určena k získání seznamu Odběratelů. Lze ji použít k vyhledávání podle určité sady filtrů. Všechny parametry jsou volitelné. Data se předávají v query parametrech v odkazu.

HTTP požadavek
  • URL: https://sender-solutions.com/api/subscribers/subscribers-list/
  • HTTP metoda: GET
Příklad požadavku s maximální sadou parametrů s použitím 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}}'
Popis polí
Pole Typ Povinné Popis
offset int Počet nalezených odběratelů z výsledného seznamu, které je třeba přeskočit. Je potřeba pro možnost dávkového (stránkovaného) čtení dat. Výchozí — 0.
limit int Maximální počet odběratelů, kteří budou vráceni v odpovědi na tento požadavek. Je potřeba pro možnost dávkového (stránkovaného) čtení dat. Výchozí — 50, maximum — 1000.
Id int Identifikátor odběratele. Pokud je uveden — používá se jako filtr.
BaseId int Identifikátor databáze odběratelů. Pokud je uveden — používá se jako filtr.
ClientUserId string ID odběratele v systému klienta. Pokud je uveden — používá se jako filtr.
Email string E-mail odběratele. Pokud je uveden — používá se jako filtr.
IsActive int Příznak aktivity odběratele. Pokud je uveden — používá se jako filtr. Uveďte 0 pro vyhledávání neaktivních odběratelů a 1 — pro aktivní.
FirstName string Jméno odběratele. Pokud je uvedeno — používá se jako filtr.
LastName string Příjmení odběratele. Pokud je uvedeno — používá se jako filtr.
Gender string Pohlaví odběratele. Pokud je uvedeno — používá se jako filtr. Možné hodnoty: "male" — mužské, "female" — ženské, prázdný řetězec — hodnota «Neuvedeno».
Příklad úspěšné odpovědi ve formátu JSON
{
    "success": true,
    "SubscribersList": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 10,
        "Subscribers": [
            {
                "Id": 25,
                "Base": {
                    "Id": 13,
                    "Name": "Test Users"
                },
                "IsActive": true,
                "Email": "username@example.com",
                "FirstName": "Cat",
                "LastName": "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"
            }
        ]
    }
}

V této odpovědi pole SubscribersList.TotalCount znamená celkový počet odběratelů nalezených podle požadavku. Pole SubscribersList.Offset a SubscribersList.Limit duplikují hodnoty z požadavku s ohledem na omezení minimálních a maximálních hodnot. Pole SubscribersList.Subscribers obsahuje pole odběratelů.