Pagination

Learn how to paginate our API responses.

All top-level API resources support bulk fetches via “list” API methods. For instance, among other resources, you can list clients and documents.

These requests will be paginated to 100 items by default. You can specify further pages using the page query parameter.

You can use the query parameters below for all our list API methods:

Pagination attributes

Query Parameter

Description

createdAfter

A "greater than" filter on the list based on the resource createdAt field.

createdBefore

A "less than" filter on the list based on the resource createdAt field.

updatedAfter

A "greater than" filter on the list based on the resource updatedAt field.

updatedBefore

A "less than" filter on the list based on the resource updatedAt field.

pageSize

Indicates how many records each page should contain. The value must be between 1 and 1000. The default is 100.

page

Specifies the page number to retrieve. The value must be greater than 1.

Example request

curl -X GET https://api.complycube.com/v1/clients?page=1&pageSize=20 \
     -H 'Authorization: <YOUR_API_KEY>'

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

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

// For clients
const clients = await complycube.client.list({
    page: 1,
    pageSize: 20
});

// For documents. Similarly done for addresses, checks, live photos, etc.
const documents = await complycube.document.list("CLIENT_ID", {
    page: 1,
    pageSize: 20
});

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

# For clients
clients = cc_api.clients.list(page=1,pageSize=20)

# For documents. Similarly done for addresses, checks, live photos, etc.
documents = await complycube.document.list("CLIENT_ID", page=1,pageSize=20);

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

// For clients
$clients = $ccapi->clients()->list(['page' => 1, 'pageSize' => 20]);

// For documents. Similarly done for addresses, checks, live photos, etc.
$documents = $ccapi->documents()->list('CLIENT_ID', 
                                       ['page' => 1, 'pageSize' => 20]);

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var req = new PageRequest { page = 1, pageSize = 20 };

var clients = await clientApi.ListAsync(pageRequest : req);

PreviousFiltering NextErrors

Good night

hashtagPagination attributes

hashtagExample request

Pagination attributes

Example request