List clients

List clients

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

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

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.

Headers

Name	Type	Description
Authorization	string	The live or sandbox API key.

200 Clients successfully retrieved.

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 3,
    "pages": 1,
    "items": [
        {
            "id": "5eb06507565eae00081ce258",
            "entityName": "John Doe",
            "type": "person",
            "email": "[e-mail]",
            "mobile": "[phone]",
            "telephone": "[phone]",
            "joinedDate": "2020-01-01",
            "personDetails": {
                "firstName": "John",
                "lastName": "Doe",
                "dob": "1990-01-01",
                "nationality": "GB"
            },
            "createdAt": "2020-05-01T18:55:03.015Z",
            "updatedAt": "2020-05-01T18:55:03.015Z"
        },
        {
            "id": "5eb05539ea91db0007ecd5b7",
            "entityName": "John Doe",
            "type": "person",
            "email": "[e-mail]",
            "mobile": "[phone]",
            "telephone": "[phone]",
            "joinedDate": "2020-01-01",
            "personDetails": {
                "firstName": "John",
                "lastName": "Doe",
                "dob": "1990-01-01",
                "nationality": "GB"
            },
            "createdAt": "2020-05-01T17:47:37.297Z",
            "updatedAt": "2020-05-01T17:47:37.297Z"
        },
        {
            "id": "5eb04fcd0f3e360008035eb1",
            "entityName": "John Doe",
            "type": "person",
            "email": "[e-mail]",
            "mobile": "[phone]",
            "telephone": "[phone]",
            "joinedDate": "2020-01-01",
            "personDetails": {
                "firstName": "John",
                "lastName": "Doe",
                "dob": "1990-01-01"
            },
            "createdAt": "2020-05-01T17:24:29.146Z",
            "updatedAt": "2020-05-01T17:24:29.146Z"
        }
    ]
}

You can use pagination and client filters for this endpoint.

Example request

cURL

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

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const clients = await complycube.client.list();

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

client_list = cc_api.clients.list()

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$clients = $ccapi->clients()->list();