Pagination - Lago

Many API endpoints that return lists of resources support pagination, enabling you to manage large result sets efficiently. You can control which results are returned by specifying the page and per_page query parameters. Paginated responses include a meta object that provides detailed pagination information, such as:

current_page: The current page number.
next_page: The next page number, if available.
prev_page: The previous page number, if available.
total_pages: The total number of pages.
total_count: The total number of records available.

{
  "coupons": [
    // ...
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": 1,
    "total_pages": 10,
    "total_count": 100
}

Parameters

integer

default:1

required

The page number to return.

integer

required

The number of results per page. In most cases, the default value is 100.

List response

number

required

The current page number.

number

The next page number.

number

The previous page number.

number

required

The total number of pages.

number

required

The total number of records.

​Parameters

​List response

Parameters

List response