Product DocumentationConga Community

Pagination

Suggest Edits

You can use pagination to move through pages of API call results for most collection endpoints. Use the page and limit query parameters to enable pagination in the response. You must use integers for both parameters.

The API's response returns paginated results, if there are any. If there are no results for the given request, the API returns a 204: No Content. See the Status & Error Codes page for examples.

🚧

Pagination Limitations

  • By default, the page is set to 1 and can have a maximum value of up to 1,000.
  • By default, the limit is set to 1000 and can have a maximum value of up to 10,000.
  • page cannot be used without setting a limit

Content-Range Header

Additional information about the result set can be obtained by parsing the Content-Range header in the response, including:

  • Resource requested
  • Index of the first item
  • Index of the last item
  • Total number of records ignoring pagination for the given request criteria.

Examples

Example: GET The first page of the products list with 10 results of a total of 200

Query Parameters
NameRequiredTypeDescription
limitOptionalnumberThe number of records per page.
pageOptionalnumberThe requested page within the collection.
Request
curl --request GET \
     --url 'https://rlp-dev.congacloud.io/api/revenue-admin/v1/products?page=1&limit=10' \
     --header 'Accept: application/json' \
Content-Range Header

Content-Range: Products 1–10 / 200

Example: GET Get 10 products on page 3 of a possible 200 products

Query Parameters
NameRequiredTypeDescription
limitOptionalnumberThe number of records per page.
pageOptionalnumberThe requested page within the collection.
Request
curl --request GET \
     --url 'https://rlp-dev.congacloud.io/api/revenue-admin/v1/products?page=3&limit=10' \
     --header 'Accept: application/json' \
Content-Range Header

Content-Range: Products 21–30 / 200

Updated 4 months ago