Skip to main content
GET
/
v1
/
accounts
JavaScript
import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const accountListResponse of client.accounts.list()) {
  console.log(accountListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "type": "account",
      "currency": "EUR",
      "account_type": "virtual_account",
      "status": "pending",
      "asset_type": "fiat",
      "label": "<string>",
      "financial_addresses": [
        {
          "type": "iban",
          "iban": "<string>",
          "account_holder_name": "<string>",
          "bic": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Query Parameters

​
limit
integer
default:10

Number of results per page (1-100). Defaults to 10.

Required range: 1 < x < 100
​
cursor
string

Opaque cursor from a previous next_cursor.

​
account_number
string

Filter by exact fiat account number. Crypto wallets are excluded when set.

Minimum string length: 1
​
account_holder_name
string

Filter by account holder name (case-insensitive phrase match). Crypto wallets are excluded when set.

Minimum string length: 1
​
status
enum<string>

Filter by account status.

Available options:
pending,
active,
frozen
​
parent_id
string<uuid>

ID of the account program to list virtual accounts for.

Response

200 - application/json

List of accounts

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string | null
required