GET/api/v1/get-vault

Get a vault

Returns one vault in full: its address and script type, its approval threshold and signer set, and its spending limit with current usage.

AccessRequires a permission in the workspaceVIEW_BALANCES

The response is a Vault, documented under Shared objects. It is the single-vault counterpart of GET /api/v1/list-wallets, and the place to read a vault's address after creating it. As on the list call, limit_error appears in place of detailed_vault_limits when the spending policy could not be read.

The vault must belong to the workspace you pass in workspace_id, and you must hold VIEW_BALANCES in that workspace. A vault in any other workspace is not returned: data and permissions never cross workspace boundaries.

Query parameters

vault_idstringrequired

The vault to show, as returned by create_wallet or list-wallets.

workspace_idnumberrequired

The workspace the vault belongs to. You must hold VIEW_BALANCES in it.

bash

curl "$SQRL_API/api/v1/get-vault?vault_id=vault_01HZXB2K7P&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  vault_id: "vault_01HZXB2K7P",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-vault?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { address, m, n, detailed_vault_limits } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-vault", api_base))
    .query(&[("vault_id", "vault_01HZXB2K7P"), ("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"id": "vault_01HZXB2K7P",
"user_id": "4021",
"workspace_id": "342",
"name": "Issuance vault",
"network": "mainnet",
"m": 2,
"n": 3,
"script_type": "p2wsh",
"witness_script_hex": "5221024f8e…53ae",
"address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
"created_at": "2026-06-14T10:22:03Z",
"updated_at": "2026-07-28T16:41:19Z",
"detailed_vault_limits": {
  "Limit": "250000.00",
  "CyclePeriod": "M",
  "CycleDay": 1,
  "Used": "18400.50",
  "Unused": "231599.50",
  "NextReset": "2026-09-01T00:00:00Z"
},
"signers": [
  { "key_index": 0, "first_name": { "String": "Ada", "Valid": true }, "surname": { "String": "Okafor", "Valid": true } },
  { "key_index": 1, "first_name": { "String": "Ben", "Valid": true }, "surname": { "String": "Iversen", "Valid": true } },
  { "key_index": 2, "first_name": { "String": "Chi", "Valid": true }, "surname": { "String": "Nakamura", "Valid": true } }
]
}

Was this page helpful?