List Wallets

The List Wallets endpoint provides a way to retrieve all wallets within a specific Signchain Vault.

Endpoint

GET/api/v1/vaults/:vaultId/wallets

Test Endpoint

Request Headers

Authorization: Bearer token for authentication. Should be Bearer <Your-API-Key>.
Content-Type: Must be application/json.
Accept: Must be application/json.

Request Parameters

vaultId - The unique identifier of the vault containing the wallets you want to list.

Query Parameters

offset - Used for pagination, skip offset records in the result set.
count - Used for pagination, return a maximum of count results. This number cannot be greater than 1000.

Example Request

curl -X GET https://signchain.net/api/v1/vaults/{vaultId}/wallets \
     -H "Authorization: Bearer <API_KEY>"

Example Response

{
  "success": Request_Success_Status,
  "data": {
    "count": Total_Wallet_Count_In_Result_Set,
    "page": [
      {
        "id": "<Your-Wallet-ID>",
        "account": "<Your-Account-ID>",
        "vault": "<Your-Vault-ID>",
        "name": "<Your-Wallets-Name>",
        "address": "<Your-Unique-Wallet-Address>",
        "created": "<Current-Date-ISO>",
        "updated": "<Current-Date-ISO>",
        "expires": "<Wallet-Expiry-Date-ISO>"
      },
      {
        "id": "<Your-Wallet-ID>",
        "account": "<Your-Account-ID>",
        "vault": "<Your-Vault-ID>",
        "name": "<Your-Wallets-Name>",
        "address": "<Your-Unique-Wallet-Address>",
        "created": "<Current-Date-ISO>",
        "updated": "<Current-Date-ISO>",
        "expires": "<Wallet-Expiry-Date-ISO>"
      },
      ...Other_Wallets_In_Result_Set
    ]
  },
  "error": "<Error-Message>"
}

Response

The response includes an array of wallet objects, each with the following fields:

success: A boolean true or false determining whether the list request was successful or not. If the list request was not successful, this value will be false and the error field will be populated.
error: A string error message, only sent if the success parameter is false.
count: The total number of wallets contained in this vault.
page: An array containing current page of results as determined by offset and count in the request.
- id (string) - The unique identifier of the wallet within the vault.
- account (string) - Your Signchain account ID.
- vault (string) - Your vault's unique identifier.
- name (string) - The descriptive name assigned to the wallet.
- address (string) - The unique Ethereum address of the wallet.
- created (string, ISO 8601 format) - The date and time when the wallet was created.
- updated (string, ISO 8601 format) - The last updated date of the wallet, which will be when it was created.
- expires (optional, string, ISO 8601 format) - If the wallet is set to expire, then this field will be included and is the date the wallet is marked for expiry and deletion, including all private key data associated with the wallet.

The List Wallets endpoint is ideal for viewing all wallets within a vault, providing comprehensive insight into wallet details and statuses in a single request.

Signchain Docs