Sign in

Query

post/v2/prism/{teamId}/document/query

Path parameters

teamIdstring uuid required

Request body

cursorstring

Alternative location for the opaque cursor (a sibling of query). Use whichever feels more natural; if both are present, query.cursor wins.

include_totalboolean

When true, the response includes a total field with the unpaginated row count. Costs an additional pass over the result set — for unfiltered totals prefer GET /v2/prism/{teamId}/{objectType}/count instead.

deletedboolean
sourcesstring[]
boxesstring[]

Response

Successful query

has_moreboolean required

Accurate end-of-data signal. False when this page contains the last record; true only when at least one more record exists. (Implementation note: the server fetches one extra row internally to determine this — clients never need to overshoot to discover the end.)

next_cursorstring nullable

Opaque cursor pointing at the next page. Pass it back unchanged in the request body (cursor) of the next call. Null when has_more is false.

totalinteger nullable

Only populated when the request set include_total: true. Total number of records matching the query, ignoring pagination. Opt-in because it costs an additional pass over the result set.

Changes