# List Vaults

Get a list of all vaults in an organization.

Endpoint: GET /api/v1/vaults
Version: 0.2.0
Security: bearerAuth

## Query parameters:

  - `sort_by` (array)

  - `page` (integer)
    The page number to fetch.

  - `size` (integer)
    The number of items per page.

  - `skip_count` (boolean)
    Whether to skip counting the total number of items.

  - `vault_ids` (array)
    Vault IDs to filter on.

  - `names` (array)
    List of full names to filter on.

  - `vault_types` (array)
    Vault types to filter on.

  - `vault_states` (array)
    Vault states to filter on.

  - `key_holder_ids` (array)
    List of key holder IDs to filter on.

  - `vault_group_ids` (array)
    List of vault group IDs to filter on. Filter applies to current and pending vault groups.

  - `exclude_vault_group_ids` (array)
    List of vault group IDs to exclude.

  - `exclude_vault_ids` (array)
    Vault IDs to exclude.

  - `origin_type` (string)
    Origin type to filter on.

  - `account_addresses` (array)
    List of account addresses to filter on.

  - `positive_native_balance_chain_ids` (array)
    List of chain IDs to fetch native assets for. Only vaults with positive native balance in any of these chains will be included in native_assets response.

## Response 200 fields (application/json):

  - `total` (integer, required)

  - `page` (integer, required)

  - `size` (integer, required)

  - `vaults` (array, required)

  - `vaults.id` (string, required)
    The unique identifier of the object in the Fordefi platform.

  - `vaults.created_at` (string, required)
    The date and time when the object was created.

  - `vaults.modified_at` (string, required)
    The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

  - `vaults.name` (string, required)
    The name of the vault.

  - `vaults.created_by` (any, required)
    Represents a reference to a user in the Fordefi platform

  - `vaults.created_by.id` (string, required)
    The unique identifier of the user in the Fordefi platform.

  - `vaults.created_by.user_type` (string, required)
    The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.

  - `vaults.created_by.name` (string)
    The name of the user.
    Example: John Doe

  - `vaults.created_by.email` (string, required)
    The email of the user.

  - `vaults.created_by.state` (string, required)
    Enum: "active", "onboarding_pending_code_generation", "onboarding_pending_activation", "reset_device_pending_code_generation", "reset_device_pending_activation", "pending_approval", "deleted"

  - `vaults.created_by.role` (string, required)
    Enum: "admin", "trader", "viewer"

  - `vaults.created_by.user_type` (string, required)
    The type of the user.

  - `vaults.created_by.state` (string, required)
    The state of the user.
    Enum: "active", "deleted"

  - `vaults.created_by.external_id` (string, required)
    External id of the user.
    Example: user|1234

  - `vaults.created_by.name` (string, required)
    The name is Fordefi CARE

  - `vaults.vault_groups` (array, required)
    The vault groups this vault belongs to.

  - `vaults.vault_groups.id` (string, required)
    The unique identifier of the vault group in the Fordefi platform.

  - `vaults.vault_groups.name` (string, required)
    The name of the vault group.

  - `vaults.vault_groups.vaults_count` (object, required)
    BoundCount represents a bound count of items.

  - `vaults.vault_groups.vaults_count.count` (integer, required)
    The number of items in the bound count.

  - `vaults.vault_groups.vaults_count.has_more` (boolean, required)
    Whether there are more items in the bound count.

  - `vaults.vault_groups.can_current_user_create_or_edit_vaults` (boolean, required)
    Can the current user create or edit vaults in the group's based on the group permissions

  - `vaults.skip_indexing_reason` (string)
    Enum: "spam"

  - `vaults.is_external_signer` (boolean)
    Whether the vault uses an externally imported key (external signer).

  - `vaults.native_assets` (array)
    List of native asset information for requested chains. Chain info is in asset_identifier.

  - `vaults.native_assets.priced_asset` (object, required)

  - `vaults.native_assets.priced_asset.type` (string, required)

  - `vaults.native_assets.priced_asset.asset_info` (object, required)

  - `vaults.native_assets.priced_asset.asset_info.id` (string, required)
    The asset ID.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier` (any, required)

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Aptos asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.details` (any, required)

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain` (object, required)

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.chain_type` (string, required)
    The type of the chain.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.unique_id` (string, required)
    Enum: "aptos_mainnet", "aptos_testnet", "aptos_movement_mainnet", "aptos_movement_testnet"

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.name` (string, required)
    The full blockchain name.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.native_currency_symbol` (string, required)
    The native currency symbol.
    Example: ETH

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.native_currency_name` (string, required)
    The native currency name.
    Example: Ether

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.blockchain_explorer` (object)
    A blockchain explorer entry point.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.logo_url` (string, required)
    The logo URL of the chain.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.is_testnet` (boolean, required)
    Whether the chain is on a testnet.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.chain.is_enabled` (boolean, required)
    Whether the chain is enabled.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Arch asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Canton asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Cosmos asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.exchange_type` (string, required)
    Enum: "binance", "bybit", "coinbase_international", "coinbase_us", "okx", "kraken", "paxos"

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.asset_symbol` (string, required)
    The symbol of the asset on the exchange.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Ripple asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Solana asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Stacks asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Stellar asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Starknet asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Sui asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    TON asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    TRON asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.asset_identifier.type` (string, required)
    Utxo asset identifier type.

  - `vaults.native_assets.priced_asset.asset_info.name` (string, required)
    The name of the asset.

  - `vaults.native_assets.priced_asset.asset_info.symbol` (string, required)
    The symbol (ticker) of the asset.

  - `vaults.native_assets.priced_asset.asset_info.decimals` (integer, required)

  - `vaults.native_assets.priced_asset.asset_info.verified` (boolean, required)
    `True` if this asset is verified by Fordefi, `False` otherwise.

  - `vaults.native_assets.priced_asset.asset_info.metadata_uri` (string)
    The URI of the asset metadata.

  - `vaults.native_assets.priced_asset.asset_info.is_spam` (boolean, required)
    `True` if this asset is spam, `False` otherwise.

  - `vaults.native_assets.priced_asset.asset_info.logo_url` (string)
    The URL of the asset logo.

  - `vaults.native_assets.priced_asset.asset_info.explorer_url` (string)
    The URL of a blockchain explorer that provides real-time information about the asset.

  - `vaults.native_assets.priced_asset.asset_info.issuer_name` (string)
    Best-effort display name of the issuer

  - `vaults.native_assets.priced_asset.price` (object)
    Price represents a price in a given FiatCurrency.

  - `vaults.native_assets.priced_asset.price.price_float` (string, required)
    The absolute price in the given fiat currency. When is_negative is true the asset's value is the negative of this (e.g. a debt token).
    Example: 1000000000000000000

  - `vaults.native_assets.priced_asset.price.is_negative` (boolean)
    Whether the asset's value is negative (e.g. a debt token). price_float holds the absolute value.

  - `vaults.native_assets.priced_asset.price.fiat_currency` (object, required)

  - `vaults.native_assets.priced_asset.price.fiat_currency.currency_symbol` (string, required)
    FiatCurrencySymbol
    Enum: "usd"

  - `vaults.native_assets.priced_asset.price.fiat_currency.decimals` (integer, required)
    The number of decimals in the fiat currency.

  - `vaults.native_assets.balances` (object, required)
    The cryptocurrency balances of the asset.

  - `vaults.native_assets.balances.total_mined` (string, required)
    The value of all mined assets.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.total_pending_incoming` (string, required)
    The value of all pending incoming assets.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.available_mined` (string, required)
    The value of all available mined assets. Equals to total mined balance minus frozen mined.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.available_pending_incoming` (string, required)
    The value of all available pending incoming assets. Equals to total pending incoming minus frozen pending incoming.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.frozen_mined` (string, required)
    The value of all mined frozen assets.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.frozen_pending_incoming` (string, required)
    The value of all pending incoming frozen assets.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.trustline_limit` (string)
    The trustline limit for Stellar assets. Nil for non-Stellar assets or assets without trustlines.
    Example: 1000000000000000000

  - `vaults.native_assets.balances.is_auto_approved` (boolean)
    (Canton) True if incoming transfers of this asset are auto-accepted via a pre-approval.

  - `vaults.public_key_compressed` (string, required)
    The public key of the vault in its compressed form:  For ECDSA and Schnorr keys, the public key is represented as 33 bytes (0x02 or 0x03 followed by the x-coordinate) according to the [SEC1 standard](https://www.secg.org/SEC1-Ver-1.0.pdf). For EdDSA, the public key is represented as a 32-byte value, as defined by [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032).
    Example: SGVsbG8=

  - `vaults.derivation_info` (object, required)

  - `vaults.derivation_info.derivation_path` (string, required)
    The BIP 44 derivation path of the vault.
    Example: m/44/60/0/0/0

  - `vaults.derivation_info.master_public_key` (object, required)

  - `vaults.derivation_info.master_public_key.id` (string, required)
    The ID of the key.

  - `vaults.derivation_info.master_public_key.xpub` (string, required)
    The xpub encoding of the key. For more details, see https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#serialization-format

  - `vaults.origin_type` (string, required)
    Enum: "native", "imported"

  - `vaults.state` (string, required)
    Enum: "active", "archived"

  - `vaults.type` (string, required)
    Aptos vault type.

  - `vaults.address` (string, required)
    The address of the vault on Aptos chain types.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `vaults.type` (string, required)
    Arch vault type.

  - `vaults.arch_address` (string, required)
    The address of the vault on Arch chain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `vaults.arch_mainnet_deposit_address` (object, required)

  - `vaults.arch_mainnet_deposit_address.address` (object, required)

  - `vaults.arch_mainnet_deposit_address.address.type` (string, required)

  - `vaults.arch_mainnet_deposit_address.address.address` (string, required)
    The UTXO string address.
    Example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq

  - `vaults.arch_mainnet_deposit_address.address.address_type` (string, required)
    Enum: "legacy", "p2sh", "segwit", "taproot", "merkleroot"

  - `vaults.arch_mainnet_deposit_address.address.chain` (object, required)

  - `vaults.arch_mainnet_deposit_address.address.chain.chain_type` (string, required)
    The type of the chain.

  - `vaults.arch_mainnet_deposit_address.address.chain.unique_id` (string, required)
    Enum: "bitcoin_mainnet", "bitcoin_testnet", "bitcoin_testnet_v4", "dogecoin_mainnet", "bitcoin_cash_mainnet", "pearl_testnet", "pearl_mainnet"

  - `vaults.type` (string, required)
    Black Box vault type.

  - `vaults.details` (any, required)

  - `vaults.details.type` (string, required)
    ECDSA over the Stark curve signing scheme.

  - `vaults.details.stark_key` (string, required)
    The stark public key, represented in hex format.
    Example: 0x19c78df8f4ff31e78de58575487ce1eaf19922ad9b8a714e61a441c12e0c8b2

  - `vaults.details.type` (string, required)
    ECDSA over the secp256k1 curve signing scheme.

  - `vaults.details.type` (string, required)
    Ed25519 signing scheme.

  - `vaults.details.type` (string, required)
    Schnorr over the secp256k1 curve signing scheme.

  - `vaults.type` (string, required)
    Canton vault type.

  - `vaults.address` (string, required)
    The address of the vault on Canton chain types.
    Example: 45b72ac2a9742204e6e5f521781b0648::122028536bd166988ebbb422c7f483bb32d4134127e8c171c9666ce9b518e1dd27cf

  - `vaults.type` (string, required)
    Cosmos vault type.

  - `vaults.main_address` (string, required)
    The address of the vault on Cosmos chains (hex representation without chain prefix).
    Example: DBCE78FD2D006A3BAC2C548D93271ABA3D63F01E

  - `vaults.evm_address` (string, required)
    The address of the vault on Cosmos chains that uses ethermint public key format, (hex representation without 0x).

  - `vaults.chains_addresses` (array, required)
    List of addresses of the vault on each chain (bech32 format) with chain info.

  - `vaults.chains_addresses.type` (string, required)

  - `vaults.chains_addresses.chain` (string, required)
    Enum: "cosmos_agoric-3", "cosmos_akashnet-2", "cosmos_archway-1", "cosmos_axelar-dojo-1", "cosmos_bbn-1", "cosmos_celestia", "cosmos_cosmoshub-4", "cosmos_dydx-mainnet-1", "cosmos_dydx-testnet-4", "cosmos_dymension_1100-1", "cosmos_injective-1", "cosmos_neutron-1", "cosmos_nillion-1", "cosmos_noble-1", "cosmos_osmosis-1", "cosmos_provider", "cosmos_ssc-1", "cosmos_pacific-1", "cosmos_stride-1", "cosmos_thorchain-1", "cosmos_mantra-1"

  - `vaults.chains_addresses.address` (string, required)
    The address as bech32.
    Example: cosmos1tdk0g5d4ry9lq0erejttyufqcvwpqdj6tdql38

  - `vaults.chains_addresses.hex_repr` (string)
    The hex representation of the address.
    Example: DBCE78FD2D006A3BAC2C548D93271ABA3D63F01E

  - `vaults.chains_addresses.key_type` (string)
    Enum: "secp256k1", "ethsecp256k1"

  - `vaults.type` (string, required)
    EVM vault type.

  - `vaults.address` (string, required)
    The address of the vault on EVM chain types.
    Example: 0x71C7656EC7ab88b098defB751B7401B5f6d8976F

  - `vaults.type` (string, required)
    Ripple vault type.

  - `vaults.address` (string, required)
    The address of the vault on Ripple chain types.
    Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh

  - `vaults.type` (string, required)
    Solana vault type.

  - `vaults.address` (string, required)
    The address of the vault in the Solana blockchain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `vaults.type` (string, required)
    Stacks vault type.

  - `vaults.address` (string, required)
    The address of the vault on Stacks chain types.
    Example: SP3J4NWQXC312DK0GXVRZKSRFBZG8S5FG1D2160E9

  - `vaults.type` (string, required)
    Starknet vault type.

  - `vaults.address` (string, required)
    The address of the vault on Starknet chain types.
    Example: 0x0448f450e64B50dDF49e9F95C5b63a15cD21E21a39cA2D45628d9E5B27e5e1D8

  - `vaults.activation_state` (string, required)
    Enum: "inactive", "activating", "active"

  - `vaults.activating_transaction_id` (string)
    The transaction id of the activating transaction.

  - `vaults.type` (string, required)
    Stellar vault type.

  - `vaults.address` (string, required)
    The address of the vault on Stellar chain types.
    Example: GBRPYHIL2CI3FNQ4BXLFMNDLFJHO7W3B6FSHLTAVM2A4P45SHO4ZB7I2

  - `vaults.type` (string, required)
    Sui vault type.

  - `vaults.address` (string, required)
    The address of the vault on SUI chain types.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `vaults.type` (string, required)
    TON vault type.

  - `vaults.raw_account` (string, required)
    The address TON contract in a raw format.

  - `vaults.base64_url_bounceable_account` (string, required)
    The bounceable address of the contract in base64 url format
    Example: UQBxs5hnTxjzvzsnDofRfbJeXsylUcxR8OSW7UUv317csHZ1

  - `vaults.base64_url_non_bounceable_account` (string, required)
    The non-bounceable address of the contract in base64 url format
    Example: UQBxs5hnTxjzvzsnDofRfbJeXsylUcxR8OSW7UUv317csHZ1

  - `vaults.state_init` (string, required)
    The wallet contract state init.

  - `vaults.type` (string, required)
    TRON vault type.

  - `vaults.address` (string, required)
    The address of the vault on TRON chain types.
    Example: TJCnKsPa7y5okkXvQAidZBzqx3QyQ6sxMW

  - `vaults.type` (string, required)
    UTXO vault type.

  - `vaults.default_address` (object, required)

  - `vaults.default_address.id` (string, required)
    The unique identifier of the object in the Fordefi platform.

  - `vaults.default_address.created_at` (string, required)
    The date and time when the object was created.

  - `vaults.default_address.modified_at` (string, required)
    The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

  - `vaults.default_address.vault` (object, required)
    Represents a reference to a vault in the Fordefi platform

  - `vaults.default_address.vault.id` (string, required)
    The unique identifier of the vault in the Fordefi platform.

  - `vaults.default_address.vault.vault_group_ids` (array, required)
    The unique identifiers of the vault groups this vault belongs to.

  - `vaults.default_address.vault.name` (string, required)
    The name of the vault.

  - `vaults.default_address.vault.address` (string)
    The address of the vault.

  - `vaults.default_address.vault.state` (string, required)
    Enum: "active", "archived", "deleted", "pending", "aborted"

  - `vaults.default_address.vault.type` (string, required)
    Enum: "aptos", "arch", "black_box", "canton", "cosmos", "evm", "ripple", "safe", "solana", "stacks", "starknet", "stellar", "sui", "ton", "tron", "utxo", "exchange"

  - `vaults.default_address.vault.logo_url` (string)
    The logo of the vault. Supported for exchange and Safe vaults.

  - `vaults.default_address.vault.is_external_signer` (boolean)
    Whether the vault uses an externally imported key (external signer).

  - `vaults.default_address.name` (string, required)
    The name of the address.

  - `vaults.default_address.public_key_compressed` (string, required)
    The compressed public key of the address. As defined in the SEC1 standard: https://www.secg.org/SEC1-Ver-1.0.pdf.
    Example: SGVsbG8=

  - `vaults.default_address.derivation_path` (string, required)
    The BIP-32 derivation path of the address.
    Example: m/44/60/0/0/0

  - `vaults.default_address.type` (string, required)
    The type of the vault address.

  - `vaults.default_next_address_name` (string, required)
    The default name of the next address to be created.

  - `vaults.taproot_key_public_compressed` (string)
    The compressed public key of the second key (taproot key for UTXO vault). As defined in the SEC1 standard: https://www.secg.org/SEC1-Ver-1.0.pdf.
    Example: SGVsbG8=

  - `vaults.type` (string, required)
    EXCHANGE vault type.

  - `vaults.portfolio` (object)

  - `vaults.portfolio.portfolio_id` (string, required)
    The ID of the exchange portfolio.

  - `vaults.portfolio.portfolio_name` (string, required)
    The name of the exchange portfolio.

  - `vaults.logo_url` (string, required)
    The logo of the vault.

  - `vaults.is_balance_data_outdated` (boolean, required)
    Whether the balance data is outdated.

  - `vaults.account` (any, required)
    The account details.

  - `vaults.account.type` (string, required)
    Exchange vault for a master account.

  - `vaults.account.api_key` (string, required)
    The API-key of this exchange account.

  - `vaults.account.type` (string, required)
    Exchange vault for a sub account.

  - `vaults.account.sub_account_id` (string, required)
    The ID of the sub account.

  - `vaults.account.sub_account_name` (string, required)
    The name of the sub account.

  - `vaults.change_request_id` (string, required)
    The ID of the change request.

  - `vaults.type` (string, required)
    Safe vault type.

  - `vaults.address` (string, required)
    The address of the Safe multisig wallet.
    Example: 0x71C7656EC7ab88b098defB751B7401B5f6d8976F

  - `vaults.logo_url` (string, required)
    The logo of the Safe vault.

## Response 400 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

  - `system_error_code` (string)
    An additional system error code in Fordefi.

## Response 401 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 403 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 408 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 422 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (array, required)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 500 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.