API reference Vaultody

GET /vaults/{networkType}

List Vaults

This endpoint allows users to retrieve information about their vaults and provides details about each vault's ID, name, backup status, and type (whether it's a test or main vault).

Path parameters

networkType string required

Specifies whether the vault is a main vault or a test vault.

Query parameters

context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

limit integer

Defines how many items should be returned in the response per page basis.

startingAfter string

Defines the id of the previous listed record id from which the current list should start from.

Response

Returns 200 the request has been successful.

apiVersion string required

Specifies the version of the API that incorporates this endpoint.

E.G. 2026-03-20

requestId string required

Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.

E.G. 601c1710034ed6d407996b30

context string

E.G. yourExampleString

data object required

limit integer required

Defines how many items should be returned in the response per page basis.

E.G. 50

startingAfter string

Defines the id of the previous listed record id from which the current list should start from.

E.G. 5ca21f92cf5431000105d1a7

hasMore boolean required

Defines whether or not there are more elements available after this set.

E.G. 1

items object[] required

backuped boolean required

Represents whether the Vault is backuped.

E.G. 1

changeAddressesCount integer required

The number of change addresses associated with the Vault.

E.G. 3

color string required

Represents the color of the Vault.

E.G. #2684FF

createdTimestamp integer required

Defines the specific UNIX time when the Vault was created.

E.G. 1704881727

depositAddressesCount integer required

The number of deposit addresses associated with the Vault.

E.G. 1

id string required

Defines the unique ID of the Vault.

E.G. 64d0d39df6762400071440c3

name string required

Defines the name of the Vault given to it by the user.

E.G. Vault name

type string required

Represents the type of the Vault - main/test.

main test

E.G. main

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json

401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json

403 Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. application/json

409 The data provided seems to be invalid. application/json

415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json

422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json

429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json

500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json