API > Lists > Get All Lists

GET https://emailoctopus.com/api/1.2/lists

Get details of all lists.

Parameters
api_key (string) Your API key.
limit (integer) A limit on the number of lists to return, ranging from 1 to 100. Default is 100.
page (integer) A specific page to return records from. Defaults to 1.
200 (Success) Returns
data (array of structs)

Details of each list:

id (string) The identifier of the list.
name (string) The name of the list.
created_at (string) When the list 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?api_key=00000000-0000-0000-0000-000000000000
Example Response
                        
                            {
                                "data": [
                                    {
                                        "id": "00000000-0000-0000-0000-000000000000",
                                        "name": "Foo",
                                        "created_at": "2017-11-19T15:18:41+00:00"
                                    },
                                    {
                                        "id": "00000000-0000-0000-0000-000000000001",
                                        "name": "Bar",
                                        "created_at": "2017-11-20T15:18:41+00:00"
                                    }
                                ],
                                "paging": {
                                    "next": null,
                                    "previous": null
                                }
                            }