Il metodo è destinato all'ottenimento dell'elenco degli Iscritti. Si può usare per la ricerca secondo un determinato insieme di filtri. Tutti i parametri sono opzionali. I dati vengono trasmessi nei parametri query del link.
Richiesta HTTP
- URL:
https://sender-solutions.com/api/subscribers/subscribers-list/ - Metodo HTTP: GET
Esempio di richiesta con il set massimo di parametri usando 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}}'
Descrizione dei campi
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
offset | int | Numero di iscritti trovati dall'elenco risultante che è necessario saltare. Serve per la possibilità di lettura a porzioni (per pagine) dei dati. Per impostazione predefinita — 0. | |
limit | int | Numero massimo di iscritti che verranno restituiti nella risposta a questa richiesta. Serve per la possibilità di lettura a porzioni (per pagine) dei dati. Per impostazione predefinita — 50, massimo — 1000. | |
Id | int | Identificatore dell'iscritto. Se indicato — viene usato come filtro. | |
BaseId | int | Identificatore della base di iscritti. Se indicato — viene usato come filtro. | |
ClientUserId | string | ID dell'iscritto nel sistema del cliente. Se indicato — viene usato come filtro. | |
Email | string | Email dell'iscritto. Se indicato — viene usato come filtro. | |
IsActive | int | Flag di attività dell'iscritto. Se indicato — viene usato come filtro. Indica 0 per cercare gli iscritti inattivi e 1 — per quelli attivi. | |
FirstName | string | Nome dell'iscritto. Se indicato — viene usato come filtro. | |
LastName | string | Cognome dell'iscritto. Se indicato — viene usato come filtro. | |
Gender | string | Sesso dell'iscritto. Se indicato — viene usato come filtro. Valori possibili: "male" — maschile, "female" — femminile, stringa vuota — valore «Non indicato». |
Esempio di risposta riuscita in formato 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"
}
]
}
}In questa risposta il campo SubscribersList.TotalCount indica il numero totale di iscritti trovati secondo la richiesta. I campi SubscribersList.Offset e SubscribersList.Limit duplicano i valori della richiesta tenendo conto delle restrizioni sui valori minimi e massimi. Il campo SubscribersList.Subscribers contiene un array di iscritti.