Apiture Developers Apiture Developers

Menu

  • Explore API Banking
    • API Digital Banking
    • Embedded Banking
    • Contact Us
  • Developers
    • Quick Start Guide
    • API Reference
Apiture Developers Apiture Developers
Apiture Developers

Menu

  • Explore API Banking
    • API Digital Banking
    • Embedded Banking
    • Contact Us
  • Developers
    • Quick Start Guide
    • API Reference

API Documentation

  • folder icon closed folder iconGetting Started
  • folder icon closed folder iconConcepts
    • API Keys
    • Authorization and Authentication
    • Access Tokens
    • Resources and URI Structure
    • Resource Collections
    • Resource Sets
    • Error Responses
    • Error Types
    • Markdown
    • Collection Pagination
    • Collection Filtering
    • Entitlements
  • folder icon closed folder iconGuides
    • Authenticate Users in your App using OpenID Connect
    • Listing the Balances for Accounts
    • Using Pagination
  • folder icon closed folder iconAPI Reference
  • folder icon closed folder iconRelease Notes

API Documentation

  • folder icon closed folder iconGetting Started
  • folder icon closed folder iconConcepts
    • API Keys
    • Authorization and Authentication
    • Access Tokens
    • Resources and URI Structure
    • Resource Collections
    • Resource Sets
    • Error Responses
    • Error Types
    • Markdown
    • Collection Pagination
    • Collection Filtering
    • Entitlements
  • folder icon closed folder iconGuides
    • Authenticate Users in your App using OpenID Connect
    • Listing the Balances for Accounts
    • Using Pagination
  • folder icon closed folder iconAPI Reference
  • folder icon closed folder iconRelease Notes

Collection Pagination

Most resource collections support pagination, which allows you to fetch a subset of all of the items in the collection. The subset of items is called a page. You can set a limit to how many items to include in a page.

Subsequent pages can be displayed to the user with traditional page scrolling or dynamic loaded, such as for infinite scrolling. Programs should avoid calling for and gathering large collections of resources all at once. Combine pagination with filtering to return subsets of the data that the client is interested in and needs.

nextPage_url provides the URL of the next page in the collection. Pagination can only be navigated in a forward, linear direction.

A page is identified with two query parameters:

PropertyTypeDescription
startstringThe opaque cursor that specifies the starting location of this page of items. It is not a page number. If omitted, the default is the beginning of the collection.
limitintegerThe requested page size; the maximum number of items to return in a page.

The start field is returned within the nextPage_url link in a collection, if there are more items in the collection. Clients do not define the value of the start parameter.

The limit is always returned in the collection representation to identify which page is returned. A service may return fewer items if the number of results is less than the limit, or if the limit exceeds a maximum page size for the collection. For example, even if there are 5 billion resources in a collection, a service may impose a maximum of 2,500 items at a time. The service will restrict the page contents to items the user is authorized to view.

How can we help?

Get support for your issues.

Explore API Banking

  • API Digital Banking
  • Embedded Banking
  • Contact Us

Developers

  • Get Started Guide
  • API Reference

More

  • Apiture.com

Privacy Policy

© 2022 Apiture Inc.   |   All Rights Reserved