EmailOctopus logo

API > Lists > Get Unsubscribed Contacts of List


Get details of all unsubscribed contacts of a list.

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:

id (string) The identifier of the contact.
email_address (string) The email address of the contact.
fields (object) An object containing key/value pairs of field values, using the field's tag as the key.
tags (array) An array of tags associated with the contact.
status (string) The status of the contact: SUBSCRIBED, UNSUBSCRIBED or PENDING.
created_at (string) When the contact was created, in ISO 8601 format.
last_updated_at (string) When the contact was last updated, in ISO 8601 format.
paging (struct)

URLs to navigate the results:

previous (nullable string) A link for the immediate previous page of results.
next (nullable string) A link for the immediate next page of results.
Non-200 (error) returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
Method-specific error codes
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
Example response
                                "data": [
    "id": "00000000-0000-0000-0000-000000000000",
    "email_address": "",
    "fields": {
        "FirstName": "John",
        "LastName": "Doe",
        "Birthday": "2000-12-20"
    "tags": ["vip"],
    "status": "UNSUBSCRIBED",
    "created_at": "2024-07-22T00:00:00+00:00",
    "last_updated_at": "2024-07-23T12:23:00+00:00"
    "id": "00000000-0000-0000-0000-000000000001",
    "email_address": "",
    "fields": {
        "FirstName": "Jane",
        "LastName": "Doe",
        "Birthday": "2000-12-20"
    "tags": ["vip"],
    "status": "UNSUBSCRIBED",
    "created_at": "2024-07-22T00:00:00+00:00"

                                "paging": {
                                    "next": null,
                                    "previous": null
Code sample