API > Lists > Get Subscribed Contacts of List

GET https://emailoctopus.com/api/1.2/lists/:listId/contacts/subscribed

Get details of all subscribed 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 subscribed contacts in the list:

id (string) The identifier of the contact.
email_address (string) The email address of the contact.
first_name (string) The first name of the contact.
last_name (string) The last name of the contact.
subscribed (boolean) The subscribed status of the contact.
created_at (string) When the contact was created, in ISO 8601 format.
paging (array)

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
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.2/lists/00000000-0000-0000-0000-000000000000/contacts/subscribed?api_key=00000000-0000-0000-0000-000000000000
Example Response
                        
                            {
                                "data": [
                                    {
                                        "id": "00000000-0000-0000-0000-000000000000",
                                        
                                        "email_address": "john.doe@gmail.com",
                                        
                                        "first_name": "John",
                                        "last_name": "Doe",
                                        "subscribed": true,
                                        "created_at": "2017-11-19T15:23:02+00:00"
                                    },
                                    {
                                        "id": "00000000-0000-0000-0000-000000000001",
                                        
                                        "email_address": "jane.doe@gmail.com",
                                        
                                        "first_name": "Jane",
                                        "last_name": "Doe",
                                        "subscribed": true,
                                        "created_at": "2017-11-20T15:23:02+00:00"
                                    }
                                ],
                                "paging": {
                                    "next": null,
                                    "previous": null
                                }
                            }