Skip to main content

Query Parameters

List endpoints support:
  • per_page (int): Items per page. Default: 15, max: 100.
  • page (int): Page number. Default: 1.
Example: GET /api/v1/customers?per_page=50&page=2

Response Structure

List responses include:
  • data: Array of items for the current page
  • meta: current_page, per_page, total, from, to, last_page
  • links: first, last, prev, next URLs
Use meta.total and meta.last_page to build pagination UI or loop through all pages.