Pagination

When using a list method on a resource, COS supports parameters to specify the paging of the results returned.

Parameter

pageNumber

Page number offset to return

pageSize

How many records per page should be returned. The maximum is 50 records.

For example, if you wanted to return the the second page of your customer list with a 50 record page size, you would specify that in the request querystring as follows:

https://api.crbcos.com/core/v1/cm/customers?pageNumber=2&pageSize=50

Results are wrapped in a standard paging object as follows:

{
  "results":[
    {
      "id":"123",
      "name":"John C. Customer"
    }],
  "pageNumber":2,
  "pageSize":50,
  "hasPreviousPage":true,
  "hasNextPage":false
}

The hasPreviousPage and hasNextPage flags indicate the presence of additional pages outside of the search results.


Did this page help you?