Get a single whitelist

Find a whitelist by ID.

GET	/whitelists/{id}

Path parameters

Name	Type	Description	Required
id	string	Id of the target group	✅

Response schema

{

// Internal unique identifier

id: string;

// Legacy internal unique identifier (for retro-compatibility)

legacyId: number;

// Whitelist name

name: string;

// Whitelist status

status: "ACTIVE" | "INACTIVE";

addresses: Array<{

// Address name

name: string;

// Address currency

currency: string;

// Address value

address: string;

Optional

// List of destination tags (applicable for Ripple currency)

destinationTags?: Array<string>;

}>;

// Creation timestamp

createdAt: string;

// Last modification timestamp

updatedAt: string;

// Whitelist description

description: string | null;

}

Examples

Bash

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/whitelists/{id}"

Typescript

const url = "<base-url>/whitelists/{id}";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});

Python

import requests

url = "<base-url>/whitelists/{id}"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))