Paging

Most top-level API resources support bulk fetching via a list or index method. These list endpoints share a common structure to make handling lists, filtering and pagination easier to work with.

All list endpoints will return partial “pages” of results. These results will also contain meta information about how to get the next page of results, or the previous one, or return to the start.

It is highly recommended to use the link values to navigate your list results. This will ensure you properly page through all of resources and your result set is not affected by new resources being created, or paging scheme changing.

An example of the paging information returned for all index routes.

1
{
2
  "links": {
3
    "self": "/api/relay/rest/example_url_to_the_current_page",
4
    "first": "/api/relay/rest/example_url_to_the_first_page",
5
    "next": "/api/relay/rest/example_url_to_the_next_page",
6
    "prev": "/api/relay/rest/example_url_to_the_prev_page"
7
  },
8
  "data" : [
9
    { ... },
10
    { ... }
11
  ]
12
}