v1

latestOpenAPI 3.0.02026-07-2442242189.1 KB
Vaults

ListVaults

Retrieve a list of all vaults accessible to the authenticated user.

get/v2/vaults

Query parameters

orderBystring

SQL-like ordering specifications. Supports the fields display_name and create_time.

pageSizeinteger

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

pageTokenstring

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.

skipinteger

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.

Response

A successful response.

nextPageTokenstring

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

totalSizeinteger

Total number of items in the response, regardless of pagination.

Example response

{
  "vaults": [
    {
      "name": "vaults/95257c5a522f",
      "displayName": "Fund VI"
    }
  ]
}