Using
Searches documents via indexed fields. Filters: `"field": value` for equality or `"field": {"$gt": …}` for ranges; multiple fields are ANDed.
applies to v0.5.1POST
/store-api/json/{domain}/search
const url = 'https://example.com/store-api/json/example/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"filter":{},"limit":1,"offset":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/store-api/json/example/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "filter": {}, "limit": 1, "offset": 1 }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”domain
required
string
JSON domain
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
filter
Field → value (Eq) or {"$gt": …} / $gte / $lt / $lte / $eq.
object
limit
integer | null format: int32
offset
integer | null format: int32
Example generated
{ "filter": {}, "limit": 1, "offset": 1}Responses
Section titled “Responses”Matching documents
Media typeapplication/json
object
documents
required
Matching documents incl. _key/_version metadata.
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.
limit
required
integer format: int32
offset
required
integer format: int32
total
required
integer format: int64
Example generated
{ "documents": [ { "_key": "example", "_version": 1 } ], "limit": 1, "offset": 1, "total": 1}Invalid filter or unindexed field
Media typetext/plain
string
Domain not found
Media typetext/plain
string
Domain is being deleted
Media typetext/plain
string
JSON engine disabled
Media typetext/plain
string