GET https://emailoctopus.com/api/1.3/lists/:listId
Get details of a list.
| Parameters |
|
api_key (string)
|
Your API key.
|
| 200 (Success) Returns |
|
Details of the list:
|
id (string)
|
The identifier of the list.
|
|
name (string)
|
The name of the list.
|
|
fields (array)
|
|
tag (string)
|
The identifier used to reference the field in your emails.
|
|
type (string)
|
The type of the field - can be NUMBER or TEXT.
|
|
label (string)
|
A human readable label for the field.
|
|
fallback (string)
|
A default value for the field, used when there is no other value available.
|
|
|
created_at (string)
|
When the list was created, in ISO 8601 format.
|
|
| Non-200 (Error) Returns |
|
Details of the error:
|
code (string)
|
The error code.
|
|
message (string)
|
A description of the error.
|
|
| Method-specific Error Codes |
|
LIST_NOT_FOUND
|
The list could not be found.
|
| 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.3/lists/00000000-0000-0000-0000-000000000000?api_key=00000000-0000-0000-0000-000000000000
|
| Example Response |
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Foo",
"fields": [
{
"tag": "EmailAddress",
"type": "TEXT",
"label": "Email address",
"fallback": null
},
{
"tag": "FirstName",
"type": "TEXT",
"label": "First name",
"fallback": null
},
{
"tag": "LastName",
"type": "TEXT",
"label": "Last name",
"fallback": null
}
],
"created_at": "2018-04-18T00:00:00+00:00"
}
|