Get details of all unsubscribed contacts of a list.
Parameters | |
---|---|
api_key (string) | Your API key. |
limit (integer) | The number of records to return per page, up to a maximum of 100. Defaults to 100. |
page (integer) | A specific page to return records from. Defaults to 1. |
200 (success) returns | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data (array of structs) |
The unsubscribed contacts in the list:
|
||||||||||||||
paging (struct) |
URLs to navigate the results:
|
Non-200 (error) returns | ||||
---|---|---|---|---|
Details of the error:
|
Method-specific error codes | |
---|---|
None. |
API-wide error codes | |
---|---|
INVALID_PARAMETERS | Parameters are missing or invalid. |
API_KEY_INVALID | Your API key is invalid. |
UNAUTHORISED | You're not authorised to perform that action. |
NOT_FOUND | The requested endpoint does not exist. |
UNKNOWN | An unknown error has occurred. |
Example request | |
---|---|
/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts/unsubscribed?api_key=00000000-0000-0000-0000-000000000000 |
Example response | |
---|---|
|
Code sample
copy
|
|
---|---|
curl -X GET \ https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts/unsubscribed?api_key=00000000-0000-0000-0000-000000000000 |