The method is intended to retrieve a list of Subscribers. It can be used to search using a specific set of filters. All parameters are optional. Data is passed via query parameters in the URL.
HTTP Request
- URL:
https://sender-solutions.com/api/subscribers/subscribers-list/ - HTTP Method: GET
Example request with the maximum set of parameters using 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}}'
Field Description
| Field | Type | Required | Description |
|---|---|---|---|
offset | int | The number of subscribers from the final result set that should be skipped. Required for paginated data retrieval. Default value is 0. | |
limit | int | The maximum number of subscribers to be returned in the response. Required for paginated data retrieval. Default value is 50, maximum is 1000. | |
Id | int | Subscriber identifier. If specified, it is used as a filter. | |
BaseId | int | Subscriber base identifier. If specified, it is used as a filter. | |
ClientUserId | string | Subscriber ID in the client’s system. If specified, it is used as a filter. | |
Email | string | Subscriber email address. If specified, it is used as a filter. | |
IsActive | int | Subscriber activity flag. If specified, it is used as a filter. Use 0 to search for inactive subscribers and 1 for active subscribers. | |
FirstName | string | Subscriber first name. If specified, it is used as a filter. | |
LastName | string | Subscriber last name. If specified, it is used as a filter. | |
Gender | string | Subscriber gender. If specified, it is used as a filter. Possible values: "male" for male, "female" for female, an empty string for the value “Not specified”. |
Example of a successful JSON response
{
"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"
}
]
}In this response, the TotalCount field indicates the total number of subscribers found by the request. The Offset and Limit fields duplicate the values from the request, taking into account the minimum and maximum value constraints. The Subscribers field contains an array of subscribers.