Pagination - Lago

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/coupons?page=1&per_page=10" \
  --header "Authorization: Bearer $API_KEY"

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

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/coupons?page=1&per_page=10" \
  --header "Authorization: Bearer $API_KEY"

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

Many API endpoints that return lists of resources support pagination. Use the page and per_page query parameters to control which results are returned. 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, or null on the last page.
prev_page: The previous page number, or null on the first page.
total_pages: The total number of pages.
total_count: The total number of records available.

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/coupons?page=1&per_page=10" \
  --header "Authorization: Bearer $API_KEY"

{
  "coupons": [
    // ...
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "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. The maximum is 200. A larger value returns a 422 error with value_is_out_of_range on per_page. To fetch more records, request the next pages.

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.