Sanity Library Reference Docs
    Preparing search index...
    • A live, filterable list of workflow instances — the reactive collection primitive behind list/board/inbox surfaces. Compiles the filter with the engine's instancesQuery and subscribes through the supplied WorkflowObserver, so the reactive read and the engine's stateless one see the same rows. Rows are committed instance docs; feed one to useWorkflowSession for its live evaluation and verdicts.

      The compiled query, not filter, is the subscription key, so passing a freshly built filter object every render is safe.

      Parameters

      Returns WorkflowInstanceList