Pagination

List operations across the API paginate with offset inputs and return connection-style objects. There are two page-size regimes depending on the surface.

Request shape

Pass an offset input in the operation’s paginate argument:

Input	Used by	`limit` max	Fields
`OffsetInput`	Standard listings (`getTransactions`, `getUserCashBalances`, …)	20	`limit`, `offset`
`BulkPaginationInput`	Bulk API listings	100 (also the default)	`limit`, `offset`

query {
  getTransactions(
    filter: { }
    paginate: { limit: 20, offset: 0 }
  ) {
    transactions { transactionId amount createdAt }
    totalCount
    hasNextPage
  }
}

Response shape

Paginated queries return a connection object with the items plus paging metadata — for example TransactionConnection:

the item list (e.g. transactions)
totalCount — total items matching the filter
hasNextPage — whether more results are available

Other connection types follow the same pattern: UserCashBalanceConnection, DeclinedTransactionConnection, and PlaidBankTransactionPage.

Walking a full result set

Increase offset by limit while hasNextPage is true:

Request { limit: 20, offset: 0 }.
If hasNextPage is true, request { limit: 20, offset: 20 }, then 40, and so on.
Stop when hasNextPage is false.

Results can shift between pages if new records are created while you’re paging — transaction listings are ordered most-recent-first. For large exports, filter by a fixed date range so the underlying set is stable while you walk it.

API Reference

Conventions

Request shape

Response shape

Walking a full result set

​Request shape

​Response shape

​Walking a full result set

Request shape

Response shape

Walking a full result set