Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

All list endpoints return paginated results using cursor-based pagination. Results are ordered by created_at descending (newest first).

​
Response envelope

List endpoints return a standard envelope: 
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "payout",
      "status": "paid",
      "amount": "100.50",
      "currency": "EUR",
      "created_at": "2026-03-18T14:30:00Z",
      "updated_at": "2026-03-18T15:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJhbGciOiJkaXIi..."
}
FieldTypeDescription
dataarrayArray of resource objects
has_morebooleanWhether more results exist beyond this page
next_cursorstring | nullOpaque cursor to pass as the cursor query parameter for the next page. null when has_more is false.

​
Query parameters

ParameterTypeDefaultDescription
limitinteger10Number of results per page (1-100)
cursorstringnoneOpaque cursor from a previous next_cursor

​
Traversing pages

Fetch the first page, then pass next_cursor to get the next: 
curl "https://api.augustus.com/v1/payouts?limit=25" \
  -H "Authorization: Bearer $AUGUSTUS_API_KEY"

curl "https://api.augustus.com/v1/payouts?limit=25&cursor=eyJhbGciOiJkaXIi..." \
  -H "Authorization: Bearer $AUGUSTUS_API_KEY"
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 forward-only. There is no previous_cursor.