{% extends "rest_framework/api_basics.html" %}

{% block description %}

<p>
Lists of objects that are returned by the API are always paginated. API methods which support pagination
accept a <tt>page</tt> parameter and a <tt>page_size</tt> parameter.
If not specified, the first page is returned and the page size is set to 50. The maximum allowed
page size is 10,000.
</p>

<p>
The paginated JSON metadata includes information for navigating between the pages. This includes:
</p>

<ul>
    <li><b>page</b> - the current page number.</li>
    <li><b>pages_total</b> - the total number of pages.</li>
    <li><b>page_size</b> - number of objects returned per page.</li>
    <li><b>number_of_objects</b> - total number of objects across all pages.</li>
    <li><b>next</b> - a URL for getting the next page of results, or <tt>null</tt> if this is the last page.</li>
    <li><b>previous</b> - a URL for getting the previous page of results, or <tt>null</tt> if this is the first page.</li>
</ul>

<p>
Example:
</p>

<pre class="prettyprint">
{
    "error": null,
    "result": [
        {...},
        {...},
        {...},
        ...
    ],
    "metadata": {
        "page": 1,
        "pages_total": 4,
        "page_size": 50,
        "number_of_objects": 189,
        "next": "https://infinimetrics/api/rest/systems/1007/annotations/?page=2",
        "previous": null
        "ready": true,
    }
}
</pre>

Next: <a href="/api/docs/filtering/">Filtering &raquo;</a>

{% endblock %}