Paginated results

Many list endpoints have paginated results. Most return 50 results per page by default. Ask for up to 1000 per page with the page_size parameter, for example ?page_size=200. The item list (/item/) allows at most 250 per page. If there are more results, the next property contains the URL of the next page.

Read all results by following next until it is null. On some lists count and num_pages can be a few minutes old, so don’t work out page numbers from them. To keep your own copy of the data up to date, see Keeping your data in sync.

Follow next until it is null. A page with fewer results than the page size, or having read count results, does not mark the end of the results.

Returned data contains keys:

count

Amount of results found.

num_pages

Number of result pages.

next

URL to the next result page.

previous

URL to the previous result page.

results

Array of result objects.

Example results from https://provetcloud.com/4/api/0.1/client/?firstname__is=Brett (result objects clipped for this example):

{
    "count": 2,
    "num_pages": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3,
            "url": "https://provetcloud.com/4/api/0.1/client/3/",
            "title": "Dr.",
            "firstname": "Brett",
            "lastname": "Briggs"
        },
        {
            "id": 345,
            "url": "https://provetcloud.com/4/api/0.1/client/345/",
            "title": "Mr.",
            "firstname": "Brett",
            "lastname": "McCarthy"
        }
    ]
}