Ctrl+K

Get enterprise whitelists

get/api/v2/enterprise/{enterpriseId}/whitelists

Returns all whitelists across all wallets in the enterprise for users with blanket wallet view access.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise ID
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • coinstring
    Optional coin filter to return only whitelists for a specific coin
    Min length: >= 1 characters
  • limitstring<number>Default: 25
    Maximum number of wallet whitelists to return per page. If the result set is truncated, use the "nextBatchPrevId" value to get the next page.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next page of results, based on the "nextBatchPrevId" value from the previous page.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • addressstring
    Search for whitelist entries matching this address (case-insensitive prefix match). Returns only wallets containing matching entries.
    Min length: >= 1 characters
  • walletIdstring
    Filter to a specific wallet. Must belong to the enterprise. When provided, the coin parameter is ignored.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

200 Response

walletWhitelists array[object] required
walletId string required
The wallet ID
coin string required
The coin type of the wallet
entries array[object] required
The whitelist entries for this wallet
walletLabel string
nextBatchPrevId string
When the result set is truncated, this is the ID of the last wallet in the current page. Pass it as the "prevId" query parameter to retrieve the next page.

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id