# Fireblocks

> Work with your Fireblocks workspace: create and manage vault accounts and deposit addresses, check balances, start, follow and cancel transfers, estimate fees, and manage whitelisted wallets, with triggers for new transactions, status changes and new vault accounts.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/fireblocks

## Actions

### Add asset to vault account

Add an asset to a vault account, so it can hold and receive it. Returns the wallet's first deposit address.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.

**Outputs**

- `asset_id` (text): The asset added
- `vault_account_id` (text): The vault account
- `wallet` (object): The new wallet and its address

**Example output**

```json
{
  "asset_id": "BTC_TEST",
  "vault_account_id": "13",
  "wallet": {
    "activationTxId": "",
    "address": "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
    "enterpriseAddress": "",
    "eosAccountName": "",
    "id": "BTC_TEST",
    "legacyAddress": "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn",
    "status": "",
    "tag": ""
  }
}
```

### Cancel transaction

Cancel a transaction that hasn't started broadcasting to the blockchain yet.

**Inputs**

- Transaction ID (`transaction_id`, text, required): The Fireblocks transaction id, from 'List transactions' or an earlier step.

**Outputs**

- `success` (true/false): True once Fireblocks accepted the cancellation
- `transaction_id` (text): The transaction cancelled

**Example output**

```json
{
  "success": true,
  "transaction_id": "6d2a5f6e-5b3a-4a8e-9f1a-0c2b4e6d8a10"
}
```

### Check address

Check that an address is valid for an asset, and for XRP, DOT, XLM and EOS whether it is active and needs a tag.

**Inputs**

- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Address (`address`, text, required): The blockchain address to check.

**Outputs**

- `address` (text): The address checked
- `asset_id` (text): The asset
- `is_active` (true/false): Whether it is active on chain (XRP, DOT, XLM, EOS)
- `is_valid` (true/false): Whether the address is valid for the asset
- `requires_tag` (true/false): Whether a tag or memo must go with it

**Example output**

```json
{
  "address": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
  "asset_id": "BTC_TEST",
  "is_active": true,
  "is_valid": true,
  "requires_tag": false
}
```

### Create deposit address

Create another deposit address for an asset in a vault account, such as one per customer. Only for assets like BTC that use several addresses, or a tag or memo like XRP; account-based assets like ETH have one address.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Description (`description`, text): A note on the address, shown in the Console.
- AML customer reference (`customer_ref_id`, text): Your own id for the customer this belongs to, passed to your AML screening provider.

**Outputs**

- `address` (object): The new deposit address

**Example output**

```json
{
  "address": {
    "address": "tb1q9h7garjxpexq4hf3ymvh0gm0wsvk2hcwr8wx7k",
    "bip44AddressIndex": 2,
    "enterpriseAddress": "",
    "legacyAddress": "mvqRZBC1sK2VNa3a2a6UJkpDNmR1yMbFxB",
    "tag": ""
  }
}
```

### Create external wallet

Create a whitelisted external wallet for a counterparty, then add its addresses with 'Whitelist external address'.

**Inputs**

- Name (`name`, text, required): The wallet's name, in plain ASCII, such as the counterparty's.
- AML customer reference (`customer_ref_id`, text): Your own id for the customer this belongs to, passed to your AML screening provider.

**Outputs**

- `wallet` (object): The new wallet

**Example output**

```json
{
  "wallet": {
    "assets": [],
    "customerRefId": "",
    "id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14",
    "name": "Acme payouts"
  }
}
```

### Create transfer

Start a transfer of an asset from a vault account to another vault account, a whitelisted wallet or an address. Your workspace's policy and signers then approve and sign it; follow it with 'Get transaction'.

**Inputs**

- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Amount (`amount`, text, required): How much of the asset, in its own units, such as 0.015.
- From vault account (`source_vault_account_id`, text, required): The vault account the asset leaves.
- Send to (`destination_type`, text): Where the asset goes. Defaults to a vault account. One of: `VAULT_ACCOUNT` (A vault account), `EXTERNAL_WALLET` (A whitelisted external wallet), `INTERNAL_WALLET` (A whitelisted internal wallet), `ONE_TIME_ADDRESS` (A blockchain address). Default: `VAULT_ACCOUNT`.
- To vault account (`destination_vault_account_id`, text): The vault account the asset goes to. Only when Send to is A vault account.
- To external wallet (`destination_external_wallet_id`, text): The whitelisted external wallet. It must hold an approved address for the asset. Only when Send to is A whitelisted external wallet.
- To internal wallet (`destination_internal_wallet_id`, text): The whitelisted internal wallet. It must hold an approved address for the asset. Only when Send to is A whitelisted internal wallet.
- To address (`destination_address`, text): The blockchain address to send to. Your workspace's policy must allow one-time addresses. Only when Send to is A blockchain address.
- Destination tag or memo (`destination_tag`, text): The tag or memo the address needs, for assets such as XRP or XLM. Only when Send to is A blockchain address.
- Note (`note`, text): A note shown with the transaction in Fireblocks, not sent on chain.
- Your reference (`external_tx_id`, text): Your own unique id for the transfer. Fireblocks refuses a second transfer with the same one, so a retried step can't pay twice.
- Fee level (`fee_level`, text): How much network fee to pay. Defaults to medium. One of: `MEDIUM` (Medium (default)), `LOW`, `HIGH`.
- Fee comes out of the amount (`treat_as_gross_amount`, true/false): Take the network fee out of the amount sent, for base assets such as BTC or ETH.

**Outputs**

- `id` (text): The new transaction's id
- `status` (text): Its status, such as SUBMITTED
- `system_messages` (list): Warnings or blocks Fireblocks raised

**Example output**

```json
{
  "id": "6d2a5f6e-5b3a-4a8e-9f1a-0c2b4e6d8a10",
  "status": "SUBMITTED",
  "system_messages": []
}
```

### Create vault account

Create a vault account. Add assets to it with 'Add asset to vault account'. Vault accounts can't be deleted, only hidden.

**Inputs**

- Name (`name`, text, required): The vault account's name, in plain ASCII.
- Hide in the Console (`hidden_on_ui`, true/false): Hide it from the Console's vault list, as for accounts made for each of your end users.
- AML customer reference (`customer_ref_id`, text): Your own id for the customer this belongs to, passed to your AML screening provider.
- Auto-fuel (`auto_fuel`, true/false): Have Fireblocks' gas station top up its gas for token transfers.

**Outputs**

- `vault_account` (object): The vault account

**Example output**

```json
{
  "vault_account": {
    "assets": [],
    "autoFuel": false,
    "customerRefId": "",
    "hiddenOnUI": false,
    "id": "13",
    "name": "Customer 77",
    "tags": []
  }
}
```

### Delete external wallet

Delete a whitelisted external wallet and all its addresses.

**Inputs**

- External wallet (`wallet_id`, text, required): The whitelisted external wallet. Pick one, or give its id.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `wallet_id` (text): The wallet deleted

**Example output**

```json
{
  "deleted": true,
  "wallet_id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14"
}
```

### Estimate network fee

Get an asset's current network fee at low, medium and high levels. Fireblocks refreshes it every 30 seconds.

**Inputs**

- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.

**Outputs**

- `asset_id` (text): The asset
- `high` (object): The high fee level
- `low` (object): The low fee level
- `medium` (object): The medium fee level

**Example output**

```json
{
  "asset_id": "BTC_TEST",
  "high": {
    "baseFee": "",
    "feePerByte": "8",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00001128",
    "priorityFee": ""
  },
  "low": {
    "baseFee": "",
    "feePerByte": "2",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00000282",
    "priorityFee": ""
  },
  "medium": {
    "baseFee": "",
    "feePerByte": "4",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00000564",
    "priorityFee": ""
  }
}
```

### Estimate transfer fee

Estimate the network fee of a transfer at low, medium and high fee levels, without making it. The vault account must hold the amount.

**Inputs**

- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Amount (`amount`, text, required): How much of the asset, in its own units, such as 0.015.
- From vault account (`source_vault_account_id`, text, required): The vault account the asset leaves.
- Send to (`destination_type`, text): Where the asset goes. Defaults to a vault account. One of: `VAULT_ACCOUNT` (A vault account), `EXTERNAL_WALLET` (A whitelisted external wallet), `INTERNAL_WALLET` (A whitelisted internal wallet), `ONE_TIME_ADDRESS` (A blockchain address). Default: `VAULT_ACCOUNT`.
- To vault account (`destination_vault_account_id`, text): The vault account the asset goes to. Only when Send to is A vault account.
- To external wallet (`destination_external_wallet_id`, text): The whitelisted external wallet. It must hold an approved address for the asset. Only when Send to is A whitelisted external wallet.
- To internal wallet (`destination_internal_wallet_id`, text): The whitelisted internal wallet. It must hold an approved address for the asset. Only when Send to is A whitelisted internal wallet.
- To address (`destination_address`, text): The blockchain address to send to. Your workspace's policy must allow one-time addresses. Only when Send to is A blockchain address.
- Destination tag or memo (`destination_tag`, text): The tag or memo the address needs, for assets such as XRP or XLM. Only when Send to is A blockchain address.

**Outputs**

- `high` (object): The high fee level
- `low` (object): The low fee level
- `medium` (object): The medium fee level

**Example output**

```json
{
  "high": {
    "baseFee": "",
    "feePerByte": "8",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00001128",
    "priorityFee": ""
  },
  "low": {
    "baseFee": "",
    "feePerByte": "2",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00000282",
    "priorityFee": ""
  },
  "medium": {
    "baseFee": "",
    "feePerByte": "4",
    "gasLimit": "",
    "gasPrice": "",
    "networkFee": "0.00000564",
    "priorityFee": ""
  }
}
```

### Get total balances

Get each asset's total across all vault accounts, or across those whose names start or end with some text.

**Inputs**

- Vault names start with (`account_name_prefix`, text): Only count vault accounts whose name starts with this.
- Vault names end with (`account_name_suffix`, text): Only count vault accounts whose name ends with this.

**Outputs**

- `assets` (list): Each asset's totals
- `count` (number): How many

**Example output**

```json
{
  "assets": [
    {
      "available": "0.04",
      "balance": "0.05",
      "blockHash": "000000000000002a3c51f6e0b6ad7b3c",
      "blockHeight": "2814552",
      "frozen": "0",
      "id": "BTC_TEST",
      "lockedAmount": "0.01",
      "pending": "0",
      "staked": "0",
      "total": "0.05"
    }
  ],
  "count": 1
}
```

### Get transaction

Get one transaction with its status, amounts, fees, source, destination and blockchain hash.

**Inputs**

- Transaction ID (`transaction_id`, text, required): The Fireblocks transaction id, from 'List transactions' or an earlier step.

**Outputs**

- `transaction` (object): The transaction

**Example output**

```json
{
  "transaction": {
    "amountInfo": {
      "amount": "0.01",
      "amountUSD": "0",
      "netAmount": "0.01",
      "requestedAmount": "0.01"
    },
    "assetId": "BTC_TEST",
    "assetType": "BASE_ASSET",
    "createdAt": 1763371200000,
    "createdBy": "0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0",
    "customerRefId": "",
    "destination": {
      "id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14",
      "name": "Acme payouts",
      "subType": "External",
      "type": "EXTERNAL_WALLET"
    },
    "destinationAddress": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
    "destinationAddressDescription": "",
    "destinationTag": "",
    "externalTxId": "invoice-1042",
    "feeCurrency": "BTC_TEST",
    "feeInfo": {
      "gasPrice": "",
      "networkFee": "0.00000141",
      "serviceFee": "0"
    },
    "id": "6d2a5f6e-5b3a-4a8e-9f1a-0c2b4e6d8a10",
    "lastUpdated": 1763371500000,
    "note": "Payout 1042",
    "numOfConfirmations": 3,
    "operation": "TRANSFER",
    "rejectedBy": "",
    "signedBy": [
      "0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0"
    ],
    "source": {
      "id": "12",
      "name": "Treasury",
      "subType": "",
      "type": "VAULT_ACCOUNT"
    },
    "sourceAddress": "",
    "status": "COMPLETED",
    "subStatus": "CONFIRMED",
    "txHash": "3b1f0e9c8d7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c"
  }
}
```

### Get vault account

Get one vault account with its name, its assets and their balances, and whether it is hidden in the Console.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.

**Outputs**

- `vault_account` (object): The vault account

**Example output**

```json
{
  "vault_account": {
    "assets": [
      {
        "available": "0.04",
        "balance": "0.05",
        "blockHash": "000000000000002a3c51f6e0b6ad7b3c",
        "blockHeight": "2814552",
        "frozen": "0",
        "id": "BTC_TEST",
        "lockedAmount": "0.01",
        "pending": "0",
        "staked": "0",
        "total": "0.05"
      }
    ],
    "autoFuel": false,
    "customerRefId": "",
    "hiddenOnUI": false,
    "id": "12",
    "name": "Treasury",
    "tags": []
  }
}
```

### Get vault account balance

Get a vault account's balance of one asset: total, available, pending, frozen and locked amounts.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.

**Outputs**

- `balance` (object): The asset's balance
- `vault_account_id` (text): The vault account

**Example output**

```json
{
  "balance": {
    "available": "0.04",
    "balance": "0.05",
    "blockHash": "000000000000002a3c51f6e0b6ad7b3c",
    "blockHeight": "2814552",
    "frozen": "0",
    "id": "BTC_TEST",
    "lockedAmount": "0.01",
    "pending": "0",
    "staked": "0",
    "total": "0.05"
  },
  "vault_account_id": "12"
}
```

### Hide or show vault account

Hide a vault account from the Console's vault list, or show it again. A hidden account still works and keeps its funds.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- Visibility (`visibility`, text, required): Hidden takes it off the Console's list; shown puts it back. One of: `hidden` (Hidden in the Console), `visible` (Shown in the Console).

**Outputs**

- `hidden` (true/false): Whether it is now hidden in the Console
- `success` (true/false): True once Fireblocks made the change
- `vault_account_id` (text): The vault account

**Example output**

```json
{
  "hidden": true,
  "success": true,
  "vault_account_id": "13"
}
```

### List deposit addresses

List a vault account's deposit addresses for one asset. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Page size (`limit`, number): How many to return, 1 to 500. Fireblocks' default is 200. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `addresses` (list): The deposit addresses
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `previous_cursor` (text): Pass as 'before' for the previous page; empty on the first

**Example output**

```json
{
  "addresses": [
    {
      "address": "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
      "addressFormat": "SEGWIT",
      "assetId": "BTC_TEST",
      "bip44AddressIndex": 1,
      "customerRefId": "",
      "description": "Customer 77",
      "enterpriseAddress": "",
      "legacyAddress": "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn",
      "tag": "",
      "type": "Permanent",
      "userDefined": false
    }
  ],
  "count": 1,
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List exchange accounts

List the exchange accounts connected to the workspace, with their status and assets. Needs an API user with an Admin role.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 500. Fireblocks' default is 200. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many on this page
- `exchange_accounts` (list): The exchange accounts
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `previous_cursor` (text): Pass as 'before' for the previous page; empty on the first

**Example output**

```json
{
  "count": 1,
  "exchange_accounts": [
    {
      "assets": [],
      "id": "5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f",
      "isSubaccount": false,
      "mainAccountId": "",
      "name": "Kraken main",
      "status": "APPROVED",
      "success": true,
      "type": "KRAKEN"
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List external wallets

List the whitelisted external wallets (your counterparties' addresses), with each address and its approval status.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `wallets` (list): The external wallets

**Example output**

```json
{
  "count": 1,
  "wallets": [
    {
      "assets": [
        {
          "activationTime": "",
          "address": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
          "balance": "",
          "id": "BTC_TEST",
          "lockedAmount": "",
          "status": "WAITING_FOR_APPROVAL",
          "tag": ""
        }
      ],
      "customerRefId": "",
      "id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14",
      "name": "Acme payouts"
    }
  ]
}
```

### List internal wallets

List the whitelisted internal wallets (your organization's own addresses outside Fireblocks), with each address.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `wallets` (list): The internal wallets

**Example output**

```json
{
  "count": 1,
  "wallets": [
    {
      "assets": [
        {
          "activationTime": "",
          "address": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
          "balance": "",
          "id": "BTC_TEST",
          "lockedAmount": "",
          "status": "APPROVED",
          "tag": ""
        }
      ],
      "customerRefId": "",
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "name": "Cold storage"
    }
  ]
}
```

### List transactions

List the workspace's transactions, filtered by status, time, asset or vault account. Gets one page, newest first; to see more, run it again with the next page it gives.

**Inputs**

- Status (`status`, text): Only transactions in this status. One of: `SUBMITTED`, `PENDING_AML_SCREENING` (Pending screening), `PENDING_ENRICHMENT` (Pending enrichment), `PENDING_AUTHORIZATION` (Pending authorization), `QUEUED`, `PENDING_SIGNATURE` (Pending signature), `SIGNED`, `PENDING_3RD_PARTY_MANUAL_APPROVAL` (Pending email approval), `PENDING_3RD_PARTY` (Processing at the exchange), `BROADCASTING`, and 7 more.
- Created after (`created_after`, date and time): Only transactions created after this time.
- Created before (`created_before`, date and time): Only transactions created before this time.
- Assets (`asset_ids`, list): Only transactions of these assets.
- From vault account (`source_vault_account_id`, text): Only transactions leaving this vault account.
- To vault account (`destination_vault_account_id`, text): Only transactions arriving in this vault account.
- Blockchain hash (`tx_hash`, text): Only the transaction with this blockchain transaction hash.
- Order by (`order_by`, text): Sort by when each was created, or when it last changed. One of: `createdAt` (When created (default)), `lastUpdated` (When last changed).
- Order (`sort`, text): Newest or oldest first. Defaults to newest first. One of: `DESC` (Newest first (default)), `ASC` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 500. Fireblocks' default is 200. From 1 to 500.
- Next page cursor (`next_cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'next_cursor' for the next page; empty on the last one
- `transactions` (list): The transactions

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "transactions": [
    {
      "amountInfo": {
        "amount": "0.01",
        "amountUSD": "0",
        "netAmount": "0.01",
        "requestedAmount": "0.01"
      },
      "assetId": "BTC_TEST",
      "assetType": "BASE_ASSET",
      "createdAt": 1763371200000,
      "createdBy": "0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0",
      "customerRefId": "",
      "destination": {
        "id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14",
        "name": "Acme payouts",
        "subType": "External",
        "type": "EXTERNAL_WALLET"
      },
      "destinationAddress": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
      "destinationAddressDescription": "",
      "destinationTag": "",
      "externalTxId": "invoice-1042",
      "feeCurrency": "BTC_TEST",
      "feeInfo": {
        "gasPrice": "",
        "networkFee": "0.00000141",
        "serviceFee": "0"
      },
      "id": "6d2a5f6e-5b3a-4a8e-9f1a-0c2b4e6d8a10",
      "lastUpdated": 1763371500000,
      "note": "Payout 1042",
      "numOfConfirmations": 3,
      "operation": "TRANSFER",
      "rejectedBy": "",
      "signedBy": [
        "0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0"
      ],
      "source": {
        "id": "12",
        "name": "Treasury",
        "subType": "",
        "type": "VAULT_ACCOUNT"
      },
      "sourceAddress": "",
      "status": "COMPLETED",
      "subStatus": "CONFIRMED",
      "txHash": "3b1f0e9c8d7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c"
    }
  ]
}
```

### List users

List the workspace's Console users with their roles and whether they are enabled. Needs an API user with an Admin role.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `users` (list): The workspace's users

**Example output**

```json
{
  "count": 1,
  "users": [
    {
      "email": "jo@example.com",
      "enabled": true,
      "firstName": "Jo",
      "id": "0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0",
      "lastName": "Bloggs",
      "role": "ADMIN"
    }
  ]
}
```

### List vault accounts

List vault accounts with each asset's balance, filtered by name, asset or balance. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Name starts with (`name_prefix`, text): Only vault accounts whose name starts with this.
- Name ends with (`name_suffix`, text): Only vault accounts whose name ends with this.
- Holding asset (`asset_id`, text): Only vault accounts with a wallet for this asset.
- Balance over (`min_amount`, text): Only vault accounts whose total balance is more than this, in the asset's own units, such as 0.5.
- Order (`order`, text): Newest or oldest first. Defaults to newest first. One of: `DESC` (Newest first (default)), `ASC` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 500. Fireblocks' default is 200. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `accounts` (list): The vault accounts
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `previous_cursor` (text): Pass as 'before' for the previous page; empty on the first

**Example output**

```json
{
  "accounts": [
    {
      "assets": [
        {
          "available": "0.04",
          "balance": "0.05",
          "blockHash": "000000000000002a3c51f6e0b6ad7b3c",
          "blockHeight": "2814552",
          "frozen": "0",
          "id": "BTC_TEST",
          "lockedAmount": "0.01",
          "pending": "0",
          "staked": "0",
          "total": "0.05"
        }
      ],
      "autoFuel": false,
      "customerRefId": "",
      "hiddenOnUI": false,
      "id": "12",
      "name": "Treasury",
      "tags": []
    }
  ],
  "count": 1,
  "next_cursor": "",
  "previous_cursor": ""
}
```

### Rename vault account

Give a vault account a new name.

**Inputs**

- Vault account (`vault_account_id`, text, required): The vault account. Pick one, or give its id from an earlier step.
- New name (`name`, text, required): The vault account's new name, in plain ASCII.

**Outputs**

- `vault_account` (object): The vault account's id and new name

**Example output**

```json
{
  "vault_account": {
    "id": "13",
    "name": "Customer 77 (closed)"
  }
}
```

### Resend transaction webhooks

Send a transaction's webhook notifications again, to every webhook the workspace has, such as after an outage.

**Inputs**

- Transaction ID (`transaction_id`, text, required): The Fireblocks transaction id, from 'List transactions' or an earlier step.
- Resend created (`resend_created`, true/false): Send the 'transaction created' notification again. Defaults to yes.
- Resend status changes (`resend_status_updated`, true/false): Send the latest 'status updated' notification again. Defaults to yes.

**Outputs**

- `success` (true/false): True once Fireblocks queued the notifications
- `transaction_id` (text): The transaction

**Example output**

```json
{
  "success": true,
  "transaction_id": "6d2a5f6e-5b3a-4a8e-9f1a-0c2b4e6d8a10"
}
```

### Whitelist external address

Add an asset's address to a whitelisted external wallet. It can be sent to once it is approved (status APPROVED), as your workspace's policy decides.

**Inputs**

- External wallet (`wallet_id`, text, required): The whitelisted external wallet. Pick one, or give its id.
- Asset (`asset_id`, text, required): The asset, by its Fireblocks asset id such as BTC, ETH or USDC. Pick one the workspace holds, or type any other.
- Address (`address`, text, required): The counterparty's blockchain address for the asset.
- Tag or memo (`tag`, text): The tag or memo the address needs, for assets such as XRP or XLM.

**Outputs**

- `asset` (object): The address and its approval status
- `wallet_id` (text): The external wallet

**Example output**

```json
{
  "asset": {
    "activationTime": "",
    "address": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
    "balance": "",
    "id": "BTC_TEST",
    "lockedAmount": "",
    "status": "WAITING_FOR_APPROVAL",
    "tag": ""
  },
  "wallet_id": "3a8f1c52-7d4e-4b1a-9c6f-2e5d8b0a7f14"
}
```
