Skip to main content
POST
Search an entity: filter to matching IDs (+ optional preview rows)

Authorizations

Authorization
string
header
required

API key passed as Bearer token (e.g. "Bearer your-api-key")

Path Parameters

entity
string
required

Curated entity name — see GET /query/describe for the set the host exposes.

Body

application/json
filter
object

Recursive filter expression: a leaf {on, op, value} or an and/or/not combinator of nested filter expressions. Nesting depth is unlimited at runtime; this doc schema shows two levels.

sort
object[]
page
object
columns
string[]
preview
boolean
include_sql
boolean
scope
object

Response

ids
string<uuid>[]
required
total
integer
required
has_more
boolean
required
preview
object[]

Preview rows (when preview=true). Text-op matches add a _snippets entry per matched column.

sql
string
params
any[]