LIST

List Contact Lists

Returns a paginated list of all contact lists in your account.

Endpoint

GET v5/contactlist

Requires authentication

Path Parameters

This endpoint does not include path parameters.

None

Query Parameters

All query parameters are optional.

page
integer
Page number to return. Defaults to 1.
resultsperpage
integer
Number of results to return per page. Default is 50, maximum is 500.

Response

Returns a paginated array of contact list objects.

result_ok
boolean
Whether the request succeeded.
page
integer
Current page index.
results_per_page
integer
Number of results returned per page.
data
array
Array of contact list objects.

Examples

Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.

Request (cURL)
curl -X GET "https://api.alchemer.com/v5/contactlist?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
  "result_ok": true,
  "page": 1,
  "results_per_page": 50,
  "data": [
    {
      "id": 1,
      "list_name": "New Customers",
      "date_modified": "2012-10-23 10:46:09",
      "date_created": "2012-10-23 10:01:00",
      "user_id_created": 183830,
      "user_id_modified": 0
    },
    {
      "id": 3,
      "list_name": "Existing Customers",
      "date_modified": "2013-02-07 17:58:31",
      "date_created": "2013-02-07 17:58:31",
      "user_id_created": 183830,
      "user_id_modified": 0
    }
  ]
}