Get All Contacts of List

GET https://emailoctopus.com/api/1.6/lists/:listId/contacts

Get details of all 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 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
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?api_key=00000000-0000-0000-0000-000000000000

Example response

Example response
{ "data": [ { "id": "00000000-0000-0000-0000-000000000000", "email_address": "john.doe@example.com", "fields": { "FirstName": "John", "LastName": "Doe", "Birthday": "2000-12-20" }, "tags": ["vip"], "status": "SUBSCRIBED", "created_at": "2024-12-14T00:00:00+00:00", "last_updated_at": "2024-12-15T19:49:23+00:00" } , { "id": "00000000-0000-0000-0000-000000000001", "email_address": "jane.doe@example.com", "fields": { "FirstName": "Jane", "LastName": "Doe", "Birthday": "2000-12-20" }, "tags": ["vip"], "status": "SUBSCRIBED", "created_at": "2024-12-14T00:00:00+00:00" } ], "paging": { "next": null, "previous": null } }

                        
                            {
                                "data": [
                                        {
    "id": "00000000-0000-0000-0000-000000000000",
    
    "email_address": "john.doe@example.com",
    
    "fields": {
        "FirstName": "John",
        "LastName": "Doe",
        "Birthday": "2000-12-20"
    },
    "tags": ["vip"],
    "status": "SUBSCRIBED",
    "created_at": "2024-12-14T00:00:00+00:00",
    "last_updated_at": "2024-12-15T19:49:23+00:00"
}
,
                                        
{
    "id": "00000000-0000-0000-0000-000000000001",
    
    "email_address": "jane.doe@example.com",
    
    "fields": {
        "FirstName": "Jane",
        "LastName": "Doe",
        "Birthday": "2000-12-20"
    },
    "tags": ["vip"],
    "status": "SUBSCRIBED",
    "created_at": "2024-12-14T00:00:00+00:00"
}

                                ],
                                "paging": {
                                    "next": null,
                                    "previous": null
                                }
                            }

Code sample copy
curl -X GET \ https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts?api_key=00000000-0000-0000-0000-000000000000
$ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts?api_key=00000000-0000-0000-0000-000000000000'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); $result = curl_exec($ch); if (curl_errno($ch)) { echo 'Error:' . curl_error($ch); } curl_close($ch);
import requests params = ( ('api_key', '00000000-0000-0000-0000-000000000000'), ) response = requests.get('https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts', params=params)
var https = require('https'); var options = { hostname: 'emailoctopus.com', port: 443, path: '/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts?api_key=00000000-0000-0000-0000-000000000000', method: 'GET', }; var req = https.request(options); req.end();
package main import ( "io/ioutil" "log" "net/http" ) func main() { client := &http.Client{} req, err := http.NewRequest("GET", "https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts?api_key=00000000-0000-0000-0000-000000000000", nil) if err != nil { log.Fatal(err) } resp, err := client.Do(req) if err != nil { log.Fatal(err) } bodyText, err := ioutil.ReadAll(resp.Body) if err != nil { log.Fatal(err) } }