Using
Lists documents of a domain without filters (natural key order).
applies to v0.5.1GET
/store-api/json/{domain}/documents
const url = 'https://example.com/store-api/json/example/documents';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/store-api/json/example/documents \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”domain
required
string
JSON domain
Query Parameters
Section titled “Query Parameters”limit
integer format: int32
Page size (default 50, max 1000)
offset
integer format: int32
Documents to skip
keys_only
boolean
Return only keys, no content
Responses
Section titled “Responses”Paginated document list
Media typeapplication/json
object
documents
required
Loaded documents incl. _key/_version (empty when keys_only).
Array<object>
A document as returned by the store: _key/_version metadata merged
into the user’s fields.
object
_key
required
Document key.
string
_version
required
Write counter: 1 on create, incremented on every write.
integer format: int64
key
additional properties
The document’s own fields. A document whose content is not a JSON
object appears as a single _content field holding that value.
keys
required
Document keys of the page.
Array<string>
limit
required
integer format: int32
offset
required
integer format: int32
total
required
integer format: int64
Example generated
{ "documents": [ { "_key": "example", "_version": 1 } ], "keys": [ "example" ], "limit": 1, "offset": 1, "total": 1}Domain not found
Media typetext/plain
string
Domain is being deleted
Media typetext/plain
string
JSON engine disabled
Media typetext/plain
string