> ## Documentation Index
> Fetch the complete documentation index at: https://docs.primevault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Vaults

> Retrieve a paginated list of vaults in your organization, optionally filtered by vault name.

**GET** `/api/external/vaults/?limit={limit}&cursor={cursor}&{filters}`

## Query parameters

<ParamField query="limit" type="number">
  Requested page size. SDK default: 20.
</ParamField>

<ParamField query="cursor" type="string | null">
  First page: null/empty. Subsequent pages: the preceding `nextCursor`.
</ParamField>

<ParamField query="Filters" type="Record<string, string>">
  Resource filters, for example `vaultName`.
</ParamField>

## Response

```typescript theme={null}
interface VaultListResponse {
  results: Vault[];
  nextCursor?: string | null;
  hasNext?: boolean;
}
```

## JavaScript SDK

```typescript theme={null}
const firstPage = await apiClient.getVaults(
  { vaultName: "Treasury" },
  20,
  null,
);
```

<RequestExample dropdown>
  ```json Request example theme={null}
  {
    "query": {
      "limit": 20,
      "cursor": null,
      "vaultName": "Treasury"
    }
  }
  ```

  ```bash cURL theme={null}
  # Sample only. Generate a new signed token for each request
  # (see Authentication). Tokens expire after 120 seconds.
  curl --request GET \
    --url "https://api.primevault.com/api/external/vaults/?limit=20&vaultName=Treasury" \
    --header "Authorization: Bearer <signed JWT>" \
    --header "Api-Key: <API key>" \
    --header "Accept: application/json"
  ```

  ```typescript JavaScript SDK theme={null}
  getVaults(
    params?: Record<string, string>,
    limit?: number,
    cursor?: string | null,
  ): Promise<VaultListResponse>
  ```
</RequestExample>

<ResponseExample>
  ```json JSON example theme={null}
  {
    "results": [
      {
        "id": "vault_123",
        "orgId": "org_456",
        "subOrgId": "sub_org_123",
        "vaultName": "Treasury Vault",
        "vaultType": "DEFAULT",
        "wallets": [
          {
            "id": "wallet_123",
            "blockchain": "ETHEREUM",
            "address": "0x1234567890abcdef1234567890abcdef12345678",
            "publicKey": "0x04abcdef"
          }
        ],
        "walletsGenerated": true,
        "createdAt": "2026-08-04T10:30:00Z",
        "updatedAt": "2026-08-04T10:35:00Z",
        "isDeleted": false,
        "asset": null
      },
      {
        "id": "vault_ngn_business",
        "orgId": "org_456",
        "subOrgId": "sub_org_123",
        "vaultName": "NGN Business Account",
        "vaultType": "DEFAULT",
        "asset": "NGN",
        "wallets": [],
        "walletsGenerated": false,
        "createdAt": "2026-09-27T10:00:00Z",
        "updatedAt": "2026-09-27T10:00:00Z",
        "isDeleted": false
      }
    ],
    "nextCursor": "eyJpZCI6InZhdWx0XzEyMyJ9",
    "hasNext": true
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.