Pagination

Overview

All list endpoints return paginated results using cursor-based pagination. Results are ordered newest first, and you can page in both directions: towards older records with next_cursor and towards newer records with previous_cursor.

Response envelope

List endpoints return a standard envelope:

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "payout",
      "status": "sent",
      "amount": "100.50",
      "currency": "USD",
      "initiated_at": "2026-03-18T14:30:00Z",
      "sent_at": "2026-03-18T15:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJhbGciOiJkaXIi...",
  "has_previous": false,
  "previous_cursor": null
}

Field	Type	Description
`data`	array	Array of resource objects
`has_more`	boolean	Whether more results exist after this page (towards older records)
`next_cursor`	string \| null	Opaque cursor to pass as the `cursor` query parameter for the next (older) page. `null` when `has_more` is `false`.
`has_previous`	boolean	Whether more results exist before this page (towards newer records)
`previous_cursor`	string \| null	Opaque cursor to pass as the `cursor` query parameter for the previous (newer) page. `null` when `has_previous` is `false`.

Query parameters

Parameter	Type	Default	Description
`limit`	integer	10	Number of results per page (1-100)
`cursor`	string	none	Opaque cursor from a previous `next_cursor` or `previous_cursor`

Traversing pages

Fetch the first page, then pass next_cursor to move towards older records, or previous_cursor to move back towards newer records. Both tokens go in the same cursor parameter, and each cursor already encodes its own direction.

# First page (newest records)
curl "https://api.augustus.com/v1/payouts?limit=25" \
  -H "Authorization: Bearer $AUGUSTUS_API_KEY"

# Next page, passing next_cursor as the cursor
curl "https://api.augustus.com/v1/payouts?limit=25&cursor=eyJhbGciOiJkaXIi..." \
  -H "Authorization: Bearer $AUGUSTUS_API_KEY"

import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
for await (const payout of client.payouts.list({ limit: 25 })) {
  await processPayout(payout)
}

The SDK’s list method returns an async iterator that handles cursor traversal automatically; you don’t need to pass cursor yourself. Use the iterator when you want to walk every page; pass cursor explicitly only if you’re rendering one page at a time in your own UI.

Important notes

Cursors are opaque. Do not decode, parse, or construct them. Always use the value returned by the API.
Cursors are time-limited. An expired cursor is rejected. Start a new list request without cursor if this happens.
Changing filters between pages invalidates the cursor. Omit cursor to begin pagination again when filters change.
Pagination is bidirectional. Use next_cursor to page towards older records and previous_cursor to page back towards newer records, both via the cursor parameter. has_more and has_previous tell you when each direction is exhausted.

Getting Started

API Access

Accounts

Reconciliation

Payments

Conversions

Webhooks

Sandbox Simulations

Overview

Response envelope

Query parameters

Traversing pages

Important notes

​Overview

​Response envelope

​Query parameters

​Traversing pages

​Important notes

Overview

Response envelope

Query parameters

Traversing pages

Important notes