GET/api/v1/list-keys-workspace

List a workspace's signing keys

Lists the signing keys of everyone in a workspace, each paired with the member's name, for assembling a vault's approver set.

AccessRequires a permission in the workspacePAYMENT_INIT

Use this call when you are choosing who may approve spends from a vault: the ids it returns are the values POST /api/v1/create_wallet expects in key_ids. Every key is a Key, documented under Shared objects. Names arrive in the nullable wrapper, so check Valid before you display one.

Only the public part of a key is ever returned, here as everywhere else in the API. Private keys never leave the member's own device. Members register their own keys through POST /api/v1/register-key, so a member with no key yet does not appear with one to choose.

Query parameters

workspace_idnumberrequired

The workspace whose members' keys to list. You must hold PAYMENT_INIT in it.

bash

curl "$SQRL_API/api/v1/list-keys-workspace?workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const res = await fetch(
  `${process.env.SQRL_API}/api/v1/list-keys-workspace?workspace_id=342`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { keys } = await res.json();

rust

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

Response200 OK

{
"keys": [
  {
    "first_name": { "String": "Ada", "Valid": true },
    "surname": { "String": "Okafor", "Valid": true },
    "key": {
      "ID": "key_01HZX4M8QT",
      "UserID": "4021",
      "KeyType": "hd_xpub",
      "Status": "active",
      "PubKeyHex": { "String": "02c6047f9441ed7d…", "Valid": true },
      "Xpub": { "String": "zpub6rFR7y4Q2AijBEqTUquhVz…", "Valid": true },
      "MasterFingerprint": { "String": "7f3a1c4d", "Valid": true },
      "DerivationBasePath": { "String": "m/84'/0'/0'", "Valid": true },
      "Label": { "String": "Treasury signing key", "Valid": true },
      "Net": "mainnet",
      "CreatedAt": "2026-06-11T14:02:51Z",
      "UpdatedAt": "2026-06-11T14:02:51Z"
    }
  },
  {
    "first_name": { "String": "Ben", "Valid": true },
    "surname": { "String": "Iversen", "Valid": true },
    "key": {
      "ID": "key_01HZX52NRB",
      "UserID": "4088",
      "KeyType": "hd_xpub",
      "Status": "active",
      "PubKeyHex": { "String": "0289fa3c17be5d42…", "Valid": true },
      "Xpub": { "String": "zpub6sQm2xK9tLdBvHrT4yWnGe…", "Valid": true },
      "MasterFingerprint": { "String": "c40b92e7", "Valid": true },
      "DerivationBasePath": { "String": "m/84'/0'/0'", "Valid": true },
      "Label": { "String": "Approver key", "Valid": true },
      "Net": "mainnet",
      "CreatedAt": "2026-06-12T08:31:05Z",
      "UpdatedAt": "2026-06-12T08:31:05Z"
    }
  }
]
}

Was this page helpful?