Pagination
Pagination overview
Pagination is a process that divides a large dataset into smaller chunks. All endpoints that return a list of resources support pagination.
How it works
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.
https://api.crbcos.com/core/v1/cm/customers?pageNumber=2&pageSize=50Results 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
}