Skip to main content
POST
Error

Authorizations

​
X-API-Key
string
header
required

Headers

​
customer
string
required

Workspace identifier

Path Parameters

​
projectId
string
required

Body

application/json
​
filter
object
required

At most 50 total nodes and 5 group levels. Unknown properties, categories, fields, options, or invalid operands receive 400; no condition is silently dropped.

​
branch_id
string

Branch to read; omit or use master for Base.

Minimum string length: 1
​
cursor
string

Opaque next_cursor from the same query. These are live pages, not a frozen snapshot; restart if the filter or data model changes.

​
limit
number
default:50
Required range: 1 <= x <= 100
​
timezone
string
default:UTC

IANA timezone for calendar-date boundaries. Date-only stored values retain their calendar dates.

Response

​
entity_ids
string[]
required

Matching live entity IDs. Fetch entity records using the batch entity read endpoint.

​
next_cursor
string | null
required

Continue until null, even when entity_ids is empty. Each request examines at most the server scan budget before returning progress.