List wallets

GET {{baseUrl}}/wallets

List all wallets.

Sorting and filtering options are available via query parameters.

The default pagination is cursor based, as such you need to use the nextPageToken returned to scroll to the next result page. If a pageToken is set the offset parameter is ignored. In a case where you want to switch pagination techniques, you need to set the offset parameter instead.

Request Params

Accepts a positive integer between 0 and 9999.

Example: 100 | | limit | number | | (Optional query) Limit the number of results.

Accepts a positive integer between 1 and 100. Default: 0

Example: 20 | | sort | string | | (Optional query) Sort results.

Accepts: wallet_desc, wallet_asc, created_desc, created_asc, updated_desc, updated_asc, security_desc, security_asc. Defaults to wallet_desc

Example: wallet_asc | | attr | string | | (Optional query) Filter for wallets containing the given additional attribute name and/or value. Use the ?xattr query to exclude attributes from the search.

Accepts multiple queries to AND-combine the filter condition: ?attr[\"flag_1\"]=true&attr=foo,bar

Example: foo | | xattr | string | | (Optional query) Filter for wallets not containing the given attribute name and/or value. Use the ?attr query to include attributes from the search.

Accepts multiple queries to AND-combine the filter condition: ?xattr[\"flag_1\"]=true&xattr=foo,bar

Example: foo | | includePurged | boolean | | (Optional query) Include items that are already purged.

Defaults to false | | onlyPurged | boolean | | (Optional query) Include ONLY items that are already purged.

If this parameter is set to true, it will take priority over includePurged, which will be ignored. In this case, ONLY the purged items will be returned depending on whether includePurged is set to true or false.

Defaults to false |

HEADERS

Supports only major versions. | | Accept | string | | |

RESPONSES

status: OK

{"pageInfo":{"totalResults":42,"resultsPerPage":20,"totalHsm":10},"items":[{"wallet":"my-wallet","isPurged":false},{"wallet":"my-wallet","isPurged":false}],"nextPageToken":"NDg2ODg="}