auth.v1.AddressBookService
ListTransferDestinations
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.AddressBookService/ListTransferDestinations' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"kind": "EXTERNAL_CHAIN",
"limit": 100,
"pageToken": "eyJvZmZzZXQiOjEwMH0",
"subaccountId": "6789012345678"
}'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": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"tags": [
{
"color": "#7C3AED",
"createdAt": "2025-01-01T00:00:00Z",
"name": "Treasury",
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"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": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"whitelistStatus": "DESTINATION_NOT_WHITELISTED",
"whitelistUpdatedAt": "2025-01-01T00:00:00Z",
"whitelisted": false
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}auth.v1.ListTransferDestinationsRequestauth.v1.ListTransferDestinationsResponseOptional subaccount scope. Omit to use the root account address book.
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.
Address-book scope type.
Root account that owns this address book.
Subaccount for subaccount-scoped books. Empty for root account books.
Destination type.
Whether this destination is saved in the address book.
Whether this destination currently has an active whitelist entry.
Current active whitelist status for this destination.
Stable public id of the saved address-book entry.
Address-book scope type.
Root account that owns this address book.
Subaccount for subaccount-scoped books. Empty for root account books.
Type of saved destination.
User-defined display label.
Optional user-defined note.
Time this entry was created, as a UTC timestamp.
Time this entry was last updated, as a UTC timestamp.
External network identifier for the destination address.
Destination address on the selected external network: 1-256 characters, without whitespace or angle brackets.
Root 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.
Address-book scope type.
Root account that owns this address book.
Subaccount for subaccount-scoped books. Empty for root account books.
Human-readable tag name.
Optional UI color token for this tag.
Time the tag was created, as a UTC timestamp.
Time this tag was last updated, as a UTC timestamp.
Monotonic resource revision used for conditional updates.
External network identifier for the destination address.
Destination address on the selected external network: 1-256 characters, without whitespace or angle brackets.
Root 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.
Opaque cursor for the next page. Empty when no more results exist.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |