ListWallets

get

https://api.utila.io/v2/vaults/{vault_id}/wallets

Retrieve a list of all wallets in a vault.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vault_id

string

required

Query Params

view

string

enum

Whether to include the converted value (wallet.converted_value) in the response.

BASIC: The default view. Does not include the converted value.
FULL: Calculate and include the converted value and additional fields.

Allowed:

showArchived

boolean

Optional. When true, archived wallets are included together with non-archived wallets. When false or omitted, only non-archived wallets are returned.

filter

string

Filter results using EBNF syntax.

Supported fields:

displayName (with regex support)
createTime
external

Supported functions:

wallet_archived() - matches archived wallets. Takes no arguments. Use together with show_archived to get only archived wallets.

Examples:

displayName = "My Wallet" (All wallets with the display name "My Wallet")
regex(displayName, "^My ") (All wallets with names starting with "My ")
regex(displayName, "(?i)^mY ") (All wallets with names starting with "My ", case insensitive)
external, -external, NOT external
createTime > "2023-08-29T18:04:00Z"
createTime > "2023-08-29T18:04:00Z" AND displayName = "My Wallet"
wallet_archived() (Archived wallets only; set show_archived so archived wallets are returned)

orderBy

string

SQL-like ordering specifications. Supports the fields

display_name
create_time
update_time
converted_value.amount (available through the FULL view).

pageSize

int32

The maximum number of items to return. The service may return fewer than this value.

If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from the previous list call as nextPageToken. Provide this to retrieve the subsequent page.

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

skip

int32

How many results to skip.

Note: may be used alongside token-based pagination (see pageToken), although this won't be needed for most use cases.

includeReferencedResources

boolean

Include referenced resources in the response.

Response

200A successful response.