AddressBookService
List Transfer Destinations
List saved and whitelisted transfer destinations for one visible address book.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/auth/transfer-destinations?kind=EXTERNAL_CHAIN&limit=100&pageToken=eyJvZmZzZXQiOjEwMH0&subaccountId=6789012345678' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"destinations": [
{
"addressBookEntry": {
"addressBookEntryId": "1",
"createdAt": "2025-01-01T00:00:00Z",
"external": {
"address": "0x3333333333333333333333333333333333333333",
"polychainChainId": 1
},
"kind": "EXTERNAL_CHAIN",
"label": "Treasury Wallet",
"note": "Primary treasury destination.",
"revision": "1",
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "ROOT",
"subaccountId": "39etx65CYip"
},
"tags": [
{
"color": "#7C3AED",
"createdAt": "2025-01-01T00:00:00Z",
"name": "Treasury",
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "ROOT",
"subaccountId": "3AdvwjXFcSP"
},
"tagId": "1",
"updatedAt": "2025-01-01T00:00:00Z"
}
],
"updatedAt": "2025-01-01T00:00:00Z"
},
"external": {
"address": "0x3333333333333333333333333333333333333333",
"polychainChainId": 1
},
"kind": "EXTERNAL_CHAIN",
"saved": false,
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "ROOT",
"subaccountId": "31tWDwzBN5s"
},
"whitelistStatus": "NOT_WHITELISTED",
"whitelistUpdatedAt": "2025-01-01T00:00:00Z",
"whitelisted": false
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}Optional destination type filter.
Maximum number of destinations to return. Defaults to 200 when omitted; maximum is 500.
Opaque keyset cursor from a previous response. The cursor is exclusive and bound to account, subaccount scope, destination type filter, and stable destination sort order.
Optional subaccount scope. Omit to use the root account address book.
Address-book scope type.
ROOTRoot account that owns this address book.
7563897446546Subaccount for subaccount-scoped books. Empty for root account books.
31tWDwzBN5sDestination type.
EXTERNAL_CHAINWhether this destination is saved in the address book.
falseWhether this destination currently has an active whitelist entry.
falseCurrent active whitelist status for this destination.
NOT_WHITELISTEDStable public id of the saved address-book entry.
1Address-book scope type.
ROOTRoot account that owns this address book.
7563897446546Subaccount for subaccount-scoped books. Empty for root account books.
39etx65CYipType of saved destination.
EXTERNAL_CHAINUser-defined display label.
Treasury WalletOptional user-defined note.
Primary treasury destination.Time this entry was created, as a UTC timestamp.
2025-01-01T00:00:00ZTime this entry was last updated, as a UTC timestamp.
2025-01-01T00:00:00ZExternal network identifier for the destination address.
1Destination address on the selected external network.
0x3333333333333333333333333333333333333333Root account that owns the target internal account.
Target account or subaccount public id.
Whether target_account_id identifies a root account or a subaccount.
Smart account address for the internal transfer destination.
Username for the destination root account, when available.
Label for the destination subaccount, when the destination is a subaccount.
Stable public id of the tag.
1Address-book scope type.
ROOTRoot account that owns this address book.
7563897446546Subaccount for subaccount-scoped books. Empty for root account books.
3AdvwjXFcSPHuman-readable tag name.
TreasuryOptional UI color token for this tag.
#7C3AEDTime the tag was created, as a UTC timestamp.
2025-01-01T00:00:00ZTime this tag was last updated, as a UTC timestamp.
2025-01-01T00:00:00ZMonotonic resource revision used for conditional updates.
1External network identifier for the destination address.
1Destination address on the selected external network.
0x3333333333333333333333333333333333333333Root account that owns the target internal account.
Target account or subaccount public id.
Whether target_account_id identifies a root account or a subaccount.
Smart account address for the internal transfer destination.
Username for the destination root account, when available.
Label for the destination subaccount, when the destination is a subaccount.
Time the whitelist status was last updated, as a UTC timestamp.
2025-01-01T00:00:00ZOpaque cursor for the next page. Empty when no more results exist.
eyJvZmZzZXQiOjIwMH0| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |