Skip to main content
GET
/
v1
/
ledger
/
{ledger_key}
/
account
List Accounts
curl --request GET \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/account \
  --header 'Authorization: <authorization>'
[
  {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_ref": "<string>",
    "default_asset_code": "<string>",
    "enabled_assets": [
      {
        "asset_code": "<string>",
        "max_balance": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "min_balance": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "ACTIVE",
    "metadata": {}
  }
]

Headers

​
Authorization
string
required

The Basic Authentication header. Format: "Basic {base64(orgID:apiKey)}"

Path Parameters

​
ledger_key
string
required

The key of the ledger. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:ledger:customer_a"

Query Parameters

​
cursor
string

The cursor for the next set of results. This is an opaque string representing the starting point for the next page. For the first request, this should be omitted or set to null.

​
limit
integer<int32>
default:25

The number of items to be returned per page. Determines the page size for the paginated results. Default value: 25 Maximum value: 100 (to prevent excessive load on the server)

Response

200 - application/json

The request has succeeded.

​
account_id
string<uuid>
required

The unique identifier of the account

​
account_ref
string
required

The externally defined reference of the account

Minimum string length: 1
​
default_asset_code
string
required

The default asset for the account

Minimum string length: 1
​
enabled_assets
object[]
required

The enabled assets for the account with asset rules such as min/max balances

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
status
enum<string>

The status of the account, defaults to ACTIVE

Available options:
ACTIVE,
INACTIVE,
INACTIVE
​
metadata
object

Additional, optional, metadata for the account