List accounts

Returns a paginated list of accounts.

GET /v1/accounts

JavaScript

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);
}

200

{
  "data": [
    {
      "id": "<string>",
      "label": "<string>",
      "financial_addresses": [
        {
          "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>"
}

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

Show child attributes

has_more · boolean · required

next_cursor · string | null · required