List custom lists

URL

GET https://api.complycube.com/v1/customLists

This endpoint allows you to list all existing custom lists. The custom lists are returned sorted by creation date, with the most recent custom lists appearing first.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Query parameters

Name	Type	Description
<pagination>	string	The number of items to return and the number of pages to offset.
<filtering>	string	Filter the results.

You can use pagination for this endpoint.

Example request

cURL

curl -X GET https://api.complycube.com/v1/customLists \
     -H 'Authorization: <YOUR_API_KEY>'

Example response

Success (200)

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 1,
    "pages": 1,
    "items": [
       {
            "id": "5fd52391d8506552e4f3c8c4",
            "name": "Retail Banking Fraud (UK)",
            "description": "Entities involved in mortgage fraud.",
            "stats": {
                "personCount": 4101,
                "companyCount": 258
            },
            "createdAt": "2020-01-04T17:24:29.146Z",
            "updatedAt": "2020-01-04T17:24:29.146Z"
        }
    ]
}