Skip to main content

API Reference

API Documentation

Pagination - Response#

The GET response body can be returned with pagination to avoid requesting all the data at once.

Pagination object will always be under the paginator key.

{
"number": "The Current page, default=1",
"next_page_number": "The Next page number or null",
"previous_page_number": "The Previous page number or null",
"paginator": {
"num_pages": "The total numbers of pages"
},
"has_next": "Boolean if there is a next page",
"has_previous": "Boolean if there is a previous page"
}

Full Body Example:

{
"count": 100,
"data": ["value-0", "[...]", "value-9"],
"success": true,
"pagination": {
"number": 1,
"next_page_number": 2,
"previous_page_number": null,
"paginator": {
"num_pages": 10
},
"has_next": true,
"has_previous": false
}
}

Pagination - Parameters#

You can add those values to manipulate the pagination object in the URL Parameters.

  • page
  • limit

Example:

# To get the second page
GET - https://api.edgegap.com/v1/apps?page=2
# To change the count of element in one page (20/page)
GET - https://api.edgegap.com/v1/apps?limit=20
# You can mix those (20/page, second page)
GET - https://api.edgegap.com/v1/apps?page=2&limit=20