Pagination

To maintain optimal performance and prevent excessive response sizes, the Tupel API implements pagination for collections of resources.

Pagination Method

Tupel uses page-based pagination, meaning responses are divided into pages. Key details:

• Default page size: 10 objects per request
• Query parameter: page (integer, starting from 1)
• Pagination behavior: If there are more results, the API provides a next URL

Response Structure

List endpoints return a consistent structure that includes pagination metadata:

{
  "count": 105,  // Total number of items across all pages
  "next": null,  // URL for the next page (null if on last page)
  "previous": null,  // URL for the previous page (null if on first page)
  "items": [  // Array of resource objects for the current page
    { ... },
    { ... },
    // Up to 10 items per page
  ]
}

Best Practices

• Always check for the presence of next before requesting additional pages
• Use the complete URLs provided in next and previous fields rather than constructing your own
• Consider implementing caching if traversing many pages
• For large datasets, prefer filtered queries to reduce the number of pages needed

Page Size

Each API response contains a fixed page size of 10 objects per request. This limit ensures consistent response times and efficient data retrieval.