v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB

Address Book

ListAddressBookEntries

Retrieve a list of all address book entries in a vault.

get/v2/vaults/{vault_id}/addressBookEntries

Path parameters

vault_idstring required

Query parameters

pageSizeinteger

The maximum number of address book entries to return. The service may return fewer than this value. If unspecified, at most 50 address book entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

A page token, received from a previous ListAddressBookEntries call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAddressBookEntries must match the call that provided the page token.

filterstring

A filter expression that filters address book entries listed in the response.

Supported fields and functions:

Name	Description	Example
network	Filter by one or more networks (string...).	network("networks/ethereum-mainnet")
address	Filter by one or more addresses, case-insensitive (string...).	address("0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6")
display_name	Filter by one or more display names, exact match and case-sensitive, supports a maximum of 100 display names. (string...).	display_name("Cold Storage", "My Wallet")
create_time	Filter by creation time (string comparison).	create_time > "2023-08-29T18:04:00Z"

orderBystring

A comma-separated list of fields by which to order the results. Valid fields are:

create_time
display_name
address
network

The default sorting order is ascending. To specify descending order for a field, a suffix desc should be appended to the field name. For example: create_time desc.

Redundant field names are collapsed. For example if one specifies create_time desc, create_time, the results will be sorted by create_time desc only.

If a field is not specified, the results will be sorted by the default sorting order.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSizeinteger

The total number of address book entries that match the request criteria.

Example response

{
  "addressBookEntries": [
    {
      "name": "vaults/1b25635a5b3f/addressBookEntries/95257c5a522f",
      "address": "0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6",
      "displayName": "My DeFi Wallet",
      "network": "networks/ethereum-mainnet",
      "note": "This is my main trading wallet",
      "createTime": "2023-01-15T10:30:00Z",
      "associatedExternalWallet": "vaults/1b25635a5b3f/wallets/95257c5a522f",
      "creator": "users/1b25635a5b3f/users/95257c5a522f"
    }
  ],
  "nextPageToken": "next_page_token",
  "totalSize": 150
}