Pagination

All our Building Blocks have support for bulk fetches via “list” API methods, e.g. you can list Orders, Users, Payments, Subscriptions, etc. They all share a common structure, taking at least two parameters: size and page.
We use pagination based on a page size and current page. With these parameters, you can retrieve the data the way you want and display it using your own pagination scheme. The return of a response header contains the total count, e.g.: X-Pagination-Total: 212.
Example request using size and page:
HTTP
Core SDK & Node SDK
Python SDK
1
GET /orders?size=10&page=1 HTTP/1.1
2
Content-Type: application/json
3
Authorization: Bearer <jwt>
4
X-Builton-Api-Key: <builton-api-key>
5
Host: api.builton.dev
Copied!
1
builton.products.get({ size: 10, page: 0 }).then(pageProduct => {
2
  // pageProduct.current contains the first page.
3
  // pageProduct.page contains the current page number.
4
  // pageProduct.paginationTotal contains the total number of item you can paginate through.
5
  // pageProduct.next() will update `pageProduct.current` and `pageProduct.page` with the next page.
6
  // pageProduct.previous() will update `pageProduct.current` and `pageProduct.page` with the previous page.
7
  // pageProduct.goToPage(pageNumber) will update `pageProduct.current` and `pageProduct.page` with a specified page.
8
  // The `next`, `previous`, and `goToPage` functions accept a callback and return a Promise.
9
});
Copied!
1
orders = builton.order().search(size=10, page=0)
2
print(orders)
Copied!
You can find an example on using pagination with the Core SDK and the Node SDK here.
The more items you fetch at once, the slowest the response will be.

Nuts & Bolts - Previous

Expanding Objects

Next - Nuts & Bolts

Errors

Last modified 2yr ago

Copy link