GET/api/v1/get-workspace-whitelist

Get the workspace's token whitelists

Returns the approved-destination list of every token in the workspace, each address with its friendly name, plus a combined list of unique addresses and the tokens each one is approved for.

AccessRequires a permission in the workspacePAYMENT_INITMANAGE_WORKSPACE

One request covers every token in the workspace, which is what makes this the call behind a destination picker. contracts holds one entry per token, with the vault that owns it and the addresses that token accepts. aggregate holds one entry per unique address, with contract_uids listing the tokens it is approved for, so you can offer an address once and know which tokens may be sent to it.

These lists are the on-chain whitelists the tokens themselves enforce, not the workspace Address Book. An address in the Address Book that no token has approved does not appear here; list those with GET /api/v1/get-whitelist-addresses. To change what a token accepts, use POST /api/v1/add-to-contract-whitelist or POST /api/v1/remove-from-contract-whitelist. Whitelist Management covers how the two layers relate.

Lists can come back partial

A token whose whitelist could not be read is still listed, with an error string on its entry, and a vault that could not be reached at all is reported under vault_errors. Check both before you treat the response as the complete set of destinations, otherwise a temporary read failure looks like an empty whitelist.

Query parameters

workspace_idnumberrequired

The workspace whose token whitelists to show. You must hold either PAYMENT_INIT or MANAGE_WORKSPACE in it.

bash

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

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

rust

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

Response200 OK

{
"contracts": [
  {
    "contract_uid": 512,
    "contract_address": "9f2c8b1d4a…41a",
    "symbol": "NGT",
    "vault_uid": "vault_01HZXB2K7P",
    "addresses": [
      { "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", "name": "Settlement desk" },
      { "address": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h", "name": "Custodian omnibus" }
    ]
  },
  {
    "contract_uid": 514,
    "contract_address": "5d1b7f3e8c…92f",
    "symbol": "NGB",
    "vault_uid": "vault_01HZXD4M6S",
    "addresses": [
      { "address": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h", "name": "Custodian omnibus" }
    ]
  }
],
"aggregate": [
  {
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    "name": "Settlement desk",
    "contract_uids": [512]
  },
  {
    "address": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h",
    "name": "Custodian omnibus",
    "contract_uids": [512, 514]
  }
],
"vault_errors": [
  {
    "vault_uid": "vault_01HZXF8N3T",
    "vault_name": "Reserve vault",
    "error": "contract state unavailable"
  }
]
}

Was this page helpful?