Pagination and search

List endpoints that can return many records (e.g. List customers) return results in pages.

Parameters

integer

default:"1"

Page number, starting from 1. Values below 1 are treated as 1.

integer

default:"50"

Records per page, at most 50. Values below 1 or above 50 are treated as 50.

string

Text to search for. The customer list does a “contains” search in the customer name, customer code and tax number.

Response

integer

Returned page number.

integer

Page size that was applied.

integer

Total number of records matching the filter.

array

Records on this page.

Total number of pages: ceil(TotalCount / PageSize).

Reading all records

async function getAllCustomers(client) {
  const customers = [];
  let page = 1;

  while (true) {
    const { Data } = await client.get(`customers?page=${page}&pageSize=50`);
    customers.push(...Data.Items);

    if (page * Data.PageSize >= Data.TotalCount) break;
    page++;
  }

  return customers;
}

def get_all_customers(session):
    customers, page = [], 1
    while True:
        data = session.get(f"{BASE_URL}/customers", params={"page": page, "pageSize": 50}).json()["Data"]
        customers.extend(data["Items"])
        if page * data["PageSize"] >= data["TotalCount"]:
            break
        page += 1
    return customers

If records are added or deleted while you page through a list, a record may appear twice or be skipped. De-duplicate records by Id.

Sub-record lists (addresses, telephones and so on) belong to a single customer, so they are not paginated and return all records at once.

Getting started

Core concepts

Modules

Release notes

Pagination and search

Parameters

Response

Reading all records

​Parameters

​Response

​Reading all records

Parameters

Response

Reading all records