Vaults

List vaults

Lists vaults using ID-based pagination. See vaults.

get/vaults

Query parameters

order'asc' | 'desc'

The order in which paginated resources are returned.

Sort order by the created_at timestamp. Use asc for ascending order or desc for descending order. Defaults to desc.

limitinteger nullable

The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.

'active' | 'archived'

Whether a vault or credential is active or archived.

OR
VaultStatusParam[]

Filter by one status or a list, such as status=active or status[]=active&status[]=archived. Both statuses are included by default.

afterstring

Return resources after this resource ID in the selected order.

Response

A page of vaults.

object'list' required

The object type, which is always list.

first_idstring nullable required

The ID of the first resource in data, or null if the page is empty.

last_idstring nullable required

The ID of the last resource in data, or null if the page is empty. Pass this as after with the same order and filters.

has_moreboolean required

Whether there are more resources to retrieve after this page.

Changes