Comment on page

Pagination

Retrieving large result

All results returned are paginated by default. 
{
    "meta": {
        "next": "xqErdcgltHGs",
        "previous": null,
        "total_count": 39
    },
    "results": [
        {
            "created_at": "2021-05-06T07:00:21Z",
            "description": "Test",
            "favorite": false,
            "id": "f2eb2dab-a861-4960-b5f4-d54c61552f7d",
            "name": "Test project",
            "self": "http://localhost:4000/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d",
            "templates": "http://localhost:4000/api/v1/projects/f2eb2dab-a861-4960-b5f4-d54c61552f7d/templates",
            "updated_at": "2021-05-06T07:00:21Z"
        },
        ...
    ]
}
meta field contains the pagination metadata and result field contains the limited result set.
Querying for next set of result
Append after query string with the value from next metadata field.
https://api.usestencil.com/v1/projects?after=xqErdcgltHGs
Querying for previous set of result
Append before query string with the value from previous metadata field.
https://api.usestencil.com/v1/projects?before=xqErdcgltHGs
Limiting result
Append limit=<integer> to limit the results set
https://api.usestencil.com/v1/projects?limit=10
You can combine limit with either after and before

Account

Next - API

Status Code and Throttling

Last modified 2yr ago