v1.0
API reference Vaultody
GET /vaults/{vaultId}/vault-accounts/details

List Vault Accounts

Retrieve all Vault Accounts associated with a specific Vault.

Path parameters

vaultId string required
The ID of the vault.

Query parameters

context string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.
isHidden boolean
When it is set to true, the endpoint will return only Vault Accounts that are marked as hidden in the dashboard (isHiddenInDashboard = true).
isHideEmpty boolean
When it is set to true, the response will include only Vault Accounts that have a positive balance.
limit integer
Defines how many items should be returned in the response per page basis.
startingAfter string
Defines the id of the previous listed record id from which the current list should start from.

Response

Returns 200 the request has been successful.

apiVersion string required
Specifies the version of the API that incorporates this endpoint.
E.G. 2026-03-20
requestId string required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
E.G. 601c1710034ed6d407996b30
context string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.
E.G. yourExampleString
data object required
limit integer required
Defines how many items should be returned in the response per page basis.
E.G. 50
startingAfter string
Defines the id of the previous listed record id from which the current list should start from.
E.G. 5ca21f92cf5431000105d1a7
hasMore boolean required
Defines whether or not there are more elements available after this set.
E.G. 1
items object[] required
addressesCount string required
The total number of addresses associated with this Vault Account.
E.G. 12
balances object[] required
assetId string required
The specific id of the assets.
E.G. 6913471c6b2794841dc8fb7e
assetName string required
Full name of the asset (e.g., Ethereum, Base, Optimism, Tron, Bitcoin, Dogecoin,).
E.G. Ethereum
assetUnit string required
The commonly used symbol for the asset (e.g., ETH, BTC, TRX, BNB).
E.G. ETH
blockchain string required
The blockchain network where this asset resides (e.g., ethereum, bitcoin, optimism, tron, binance-smart-chain).
E.G. ethereum
exchangeRateUnit string required
The pricing unit used when calculating exchange rates.
E.G. USD
latestExchangeRateToUSD string required
The latest exchange rate of the asset to USD.
E.G. 2822.59
totalAmount string required
The total amount of this asset held in the Vault Account.
E.G. 0.123
createdAt integer required
The UNIX timestamp indicating when the Vault Account was first created.
E.G. 1760088530
index integer required
The sequential index of this Vault Account within its parent Vault.
E.G. 1
isFavoriteInDashboard boolean required
Indicates whether the Vault Account has been marked as a "favorite" in the dashboard.
E.G. 1
isHiddenInDashboard boolean required
Specifies whether this Vault Account is hidden from the main dashboard view.
E.G. 1
vaultAccountColour string required
A HEX color value used to uniquely visually style this Vault Account in dashboards.
E.G. #00A3BF
vaultAccountId string required
The unique id of the Vault Account.
E.G. 68dfaeae39a4b80007c4f707
vaultAccountName string required
The name of the Vault Account.
E.G. Vault Account Name
vaultId string required
The id of the Vault to which this Vault Account belongs.
E.G. 68dfaeae39a4b80007c4f707

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json
401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json
403 Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. application/json
409 The data provided seems to be invalid. application/json
415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json
422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json
429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json
500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json

No matches.