Skip to main content

Pagination​

Requests that return multiple items will be paginated by default to 10 items. Further results can be retrieved using the cursor parameter.

For most resources, you can set a limit up to 100 using the limit parameter.

Example​

curl 'https://shared-tp-api-test.30a.dev/tp-api/classes?limit=10'

The Link header includes pagination information:

Link: </entity?[...otherParams&]limit=10&cursor=eyJlbmRDdXJzb3IiOiJleUp6YTJsd0lqb3hNSDA9In0%3D>; rel="next",

The possible rel values are:

NameDescription
nextThe link relation for the immediate next page of results.

tip

It is important to form calls with Link header values instead of constructing your own URLs.