Variable | Type | Description |
---|---|---|
list_id | string|int | The ID of the list for which to get the subscribers |
status | string | Can be: subscribed, unsubscribed, bounced, spam, inactivated (lowercase) |
since | string|null | Date since joining the list (>=), UTC date, format: YYYY-MM-DD HH:mm:ss |
start_page | int|null | Optional, for large lists. The page number to start. Defaults to first page (page = 0). |
limit | int|null | Optional, for large lists. The number of results to return per page. Defaults to 100. Upper limit is 1000. |
Parameter | Description |
---|---|
abonat_id | The id of the subscriber |
The email of the subscriber | |
subscription_status | The status of the subscriber. Can be: subscribed, unsubscribed, bounced, spam, inactivated |
subscription_date | The date of the subscription |
firstname | The firstname of the subscriber |
lastname | The lastname of the subscriber |
[ { "abonat_id": 100000, "email": "email1@example.com", "subscription_status": "subscribed", "subscription_date": "2017-08-17 16:26:51", "firstname": "", "lastname": "" }, { "abonat_id": 100001, "email": "email2@example.com", "subscription_status": "subscribed", "subscription_date": "2017-08-17 16:26:51", "firstname": "", "lastname": "" }, { "abonat_id": 100003, "email": "email3@example.com", "subscription_status": "subscribed", "subscription_date": "2017-08-17 16:26:51", "firstname": "", "lastname": "" } ]
Code | Message | Description |
---|---|---|
407 | Missing required param list_id | list_id param is required |
407 | Missing required param status | status param is required |
407 | Missing required param since | since param is required |
407 | Missing required param start_page | start_page param is required |
407 | Missing required param limit | limit param is required |
137 | Invalid date/time | Invalid date/time |
801 | Please start from the first page and traverse pages consecutively. The first page is 0 | Please start from the first page and traverse pages consecutively. The first page is 0 |
101 | Not allowed for list_id = %s | Invalid access to list_id |
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Missing required param status", "code": 407 }
{ "err": true, "message": "Missing required param since", "code": 407 }
{ "err": true, "message": "Missing required param start_page", "code": 407 }
{ "err": true, "message": "Missing required param limit", "code": 407 }
{ "err": true, "message": "Please start from the first page and traverse pages consecutively. The first page is 0", "code": 801 }