Working with APIs
Pagination
9min
pagination and versioning pagination pagination is a process that divides a large dataset into smaller chunks all endpoints that return a list of resources support pagination when using a list method on a resource, our system supports parameters to specify the paging of the results returned for example, if you want to return the second page of your customer list with a 50 record page size, specify that in the request query string pagenumber integer current page number determined by the total number of records and the number of records per page pagesize integer number of records to list on a page maximum is 50 paging example https //api crbcos com/core/v1/cm/customers?pagenumber=2\&pagesize=50 results are wrapped in a standard paging object as follows id string unique identifier name string customer name pagenumber integer current page number determined by the total number of records and the number of records per page pagesize integer number of records to list on a page maximum is 50 haspreviouspage boolean true if there is a previous page, otherwise false hasnextpage boolean true if there is a next page, otherwise false { "results" \[ { "id" "123", "name" "john c customer" }], "pagenumber" 2, "pagesize" 50, "haspreviouspage"\ true, "hasnextpage"\ false } versioning all api endpoints contain a numbered version in the url whenever breaking changes are made to the api, a new major version will be created https //api crbcos com/core/v1/cm/customers breaking changes adding new required fields to request changes to the response format data type changes modifying an endpoint url removing endpoints non breaking changes adding new endpoints adding new optional fields to request adding new fields to response adding new values to fields (e g a new status value) bug fixes deprecated versions when we release a new major version, we will continue to support the previous version for a period of at least 6 months before it is deprecated