Pagination

Next Project API uses pagination to limit the response size for resources that return a potentially large collection of items.

For GET endpoints that can return many objects the parameters page and size are available in the query string to handle pagination.

A successful response from such a request has its structure shown in the example below. It contains one items node under which all returned items are listed. Apart from that it also includes paging information. The total number of available items, the current page index and the selected page size.

When the total number of items exceeds the size of one page, another piece of information will appear, namely "pages" which denotes the number of pages needed to be fetched to get the whole result set.

{
  "items": [
    { item1 },
    { item2 },
  ],
  "total": 2,
  "page": 1,
  "size": 10
}