GET endpoints which return an object list supports offset-based pagination. To get the list of all objects, you need to paginate through the results using the
offset value and
limit value. The offset parameter controls the starting point within the collection of resource results. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value: offset=0, offset=5, and offset=10. Note that the first item in the collection is retrieved by setting a zero offset.
To make it easier to navigate, the API will contruct the
links together with all the currently used query parameters. You can therefore simply use the
links object to navigate to the