Skip to main content
GET
Returns one whitelist your instance keeps or manages, with the members its record holds. Pass wallets to read, for those wallets, whether the list admits them right now, together with the list’s live owner, pending owner and managers. The members come from the record: the confirm calls and Rescan Whitelist write them. A wallet listed or removed by a transaction nobody confirmed appears only after a rescan, so check live.verified before acting on one wallet. A removed wallet stays in members with listed: false. A list another instance keeps is returned when a verified wallet of your instance owns or manages it on chain, or is named by its pending transfer. Its list then carries own: false and name: null. See Lists another instance keeps.

Path Parameters

string
required
The whitelist ID from List Whitelists: 1 to 64 letters, digits, - or _.

Query Parameters

string
Up to 200 addresses, comma-separated or as a repeated parameter, to read live from the list. Omit it to skip the chain read, and live is then absent.

Response Fields

object

Error Codes