Skip to main content

Overview

All list endpoints return paginated results to ensure optimal performance and manageable response sizes.

Request Parameters

page
integer
default:"1"
The page number to retrieve. Pages are 1-indexed.
per_page
integer
default:"50"
Number of items per page. Maximum value is 100.

Response Format

Paginated responses include metadata about the results:

Response Fields

Examples

Basic Pagination

Request the first page with default page size:

Custom Page Size

Request 20 items per page:
Get page 3 of results:

Best Practices

  • Use smaller page sizes (10-20) for real-time UIs
  • Use larger page sizes (50-100) for batch processing
  • Consider network latency and processing time
  • Check has_more before fetching next page
  • Handle empty results gracefully
  • Validate page numbers are within range
For frequently changing data:
  • Store the last item ID from each page
  • Use filters to get items after that ID
  • Prevents missing items due to insertions

Code Examples

Performance Tips

  1. Cache Results: Store paginated results when data doesn’t change frequently
  2. Parallel Requests: Fetch multiple pages simultaneously when order doesn’t matter
  3. Progressive Loading: Load initial page quickly, fetch more as needed
  4. Use Filters: Combine pagination with filters to reduce dataset size