Skip to main content
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.
Text to search for. The customer list does a “contains” search in the customer name and an exact-match search in the customer code, tax number and e-mail addresses.

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

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.