Overview
Stateway's search API lets you query process instances by their variable values and metadata — without fetching them one by one.
Query Language
Instance search uses MongoDB Query Language (MQL) syntax for filters. The $operator convention is familiar, and fields map directly to your process variables. Stateway translates your filter into safe, parameterized PostgreSQL — MongoDB is not involved.
Text Search
Text search is an opt-in mode for querying free-text content inside process variables. It is activated by including a text object in the request body alongside (or instead of) a structured filter.
Pagination
Instance search uses cursor-based pagination (keyset), not page/offset. This gives consistent results even when instances are being created or updated between pages.
Status Scope
The statusScope field controls which instances are included in the search. When omitted, the default is "active".
Performance & Indexes
Understanding stats.scanMode
Recipes
2 items