Skip to main content
GET

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Query Parameters

limit
integer

Vaults per page (1-200). Omit to receive every vault. Supplying a cursor without a limit uses 50.

Required range: 1 <= x <= 200
cursor
string

Opaque continuation cursor from pagination.next_cursor of the previous page. Must be replayed with the same API key scope and query that produced it.

query
string

Case-insensitive substring match on the vault name.

include_totals
boolean

When true, adds totals covering every vault matching the filters, not just this page. Scans all objects in those vaults, so request it once per filter change rather than on every page.

Response

Vaults retrieved successfully

vaults
object[]
total
integer

Number of vaults in this response

pagination
object
totals
object

Present only with include_totals=true. Covers every vault matching the filters, across all pages.