GET/api/v1/get-whitelist-addresses

List the Address Book

Returns the workspace Address Book, each saved address with its display name, optionally narrowed to a single token so entries already on that token's whitelist can be flagged.

AccessRequires a permission in the workspaceVIEW_BALANCES

These are the workspace's saved, named addresses. They are a convenience list, so an entry here does not mean any token accepts the address: a token enforces its own whitelist on-chain, and GET /api/v1/get-workspace-whitelist is what tells you which tokens currently approve a given address. Whitelist Management explains how the two layers relate, and Managing whitelisted addresses covers the operator workflow.

Passing contract_uid together with include_contract_match=true also flags which entries are already on that token's whitelist, which is how a picker shows saved addresses and their approval state in one list. The response shape documented for this endpoint carries only address and name on each entry and does not name the field that carries the flag, so check what comes back before you rely on it. The per-token lists from get-workspace-whitelist are authoritative either way.

Query parameters

workspace_idnumberrequired

The workspace whose Address Book to list. You must hold VIEW_BALANCES in it.

contract_uidnumberoptional

A token to compare the entries against. Send it together with include_contract_match.

include_contract_matchbooleanoptional

Set to true, with contract_uid, to flag which entries are already on that token's whitelist.

bash

curl "$SQRL_API/api/v1/get-whitelist-addresses?workspace_id=342&contract_uid=512&include_contract_match=true" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  workspace_id: "342",
  contract_uid: "512",
  include_contract_match: "true",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-whitelist-addresses?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { addresses } = await res.json();

rust

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

Response200 OK

{
"addresses": [
  {
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    "name": "Settlement desk"
  },
  {
    "address": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h",
    "name": "Custodian omnibus"
  }
]
}

Was this page helpful?