Get a custom list

URL

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

Retrieves an existing custom list.

Headers

NameTypeDescription

Authorization*

string

The API live or test key.

Path parameters

NameTypeDescription

id*

string

The ID of the custom list.

Example request

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

Example response

{
    "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"
}

Last updated