Skip to main content
GET
/
vault
/
list
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const vaultListResponse of client.vaults.list()) {
  console.log(vaultListResponse.collection);
}
{
  "items": [
    {
      "collection": "<string>",
      "document_count": 123
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Query Parameters

​
cursor
string | null
​
size
integer
default:50
Required range: 0 <= x <= 100

Response

Successful Response

​
items
Collection · object[]
required
​
next_cursor
string | null
required