List wallets

get

https://app.bitgo-test.com/api/v2/wallets

Lists all wallets you can access when the enterprise ID is provided, including:

Wallets you have a role on (admin, spender, or viewer).
Wallets in enterprises you belong to that have the View All Wallets option enabled from the enterprise settings.

If the enterprise ID is not provided, lists only the wallets you have a role on.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

array of strings

Filter by ID

coin

array of strings

Filter by coin

coin

enterprise

array of strings

Filter by enterprise.

enterprise

type

array of strings

Filter by wallet type

type

subType

array of strings

Filter by wallet sub-type

subType

deleted

boolean

Filter by deleted state

prevId

string

Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.

labelContains

string

Filter by label substring.

expandBalance

boolean

Defaults to false

Add "balanceString", "confirmedBalanceString" and "spendableBalanceString" to each wallet

excludeSpendableBalance

boolean

expandPolicy

boolean

expandCustodialWallet

boolean

Whether linked custodial wallets should be expanded inline

ignoreErrors

boolean

includeStakingBalances

boolean

Defaults to false

Include stakingBalanceString and rewardBalanceString properties for each staking wallet. Requires expandBalance to be set to true.

limit

string

Defaults to 25

Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.

offset

string

Defaults to 0

Number of documents to skip for offset-based pagination.

skipReceiveAddress

boolean

Defaults to false

Do not add "receiveAddress" to each wallet

permission

string

enum

Return only wallets for which the user has the given permission

Allowed:

pinnedWallets

string

enum

Return only pinned wallets ("pinnedOnly") or only unpinned wallets ("pinnedExcluded"), exclude to return both

Allowed:

bitgoOrg

string

enum

Return only wallets belong to the BitGo trust org

skipUnsupportedCoins

boolean

Defaults to false

Skip unsupported coins instead of returning an error

Responses

200OK

400Bad Request