Released docs. You are viewing the documentation published with v0.46.0. Development docs are available at Latest.
List a page of caller-visible runs
const url = 'https://example.com/v1/runs?limit=20&state=running&turn=party';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/runs?limit=20&state=running&turn=party' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Opaque nextCursor from the previous page. Keep every filter unchanged; a cursor from an earlier version is refused. The current caller is authorized again on each page.
True selects effective states attention and failed; false excludes both. Composes with state.
Selects runs waiting on this BReg Proposal, matched through the keyed wait commitment.
Selects runs whose Proposal wait last observed this turn.
Selects runs that finished with this workflow outcome, matched exactly. A name no run finished with selects none.
Responses
Section titled “Responses”Authorized result
object
Present when another page may exist; continue with the same filters.
object
An authorized cancellation took a parked wait’s authored onCancel path; cleanup on that path remains runnable.
Ordinary cancellation is irreversible and prevents later workflow effects; an uncertain evaluation may still have run at its provider.
Example
{ "runs": [ { "state": "running" } ]}A problem: request.invalid, request.limit-out-of-range.
object
Example
{ "code": "request.invalid", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: authentication.refused.
object
Example
{ "code": "authentication.refused", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}Headers
Section titled “Headers”Bearer authentication challenge for missing or refused credentials.
A problem: operation.not-authorized.
object
Example
{ "code": "operation.not-authorized", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: request.method-not-allowed.
object
Example
{ "code": "request.method-not-allowed", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: runtime.failure.
object
Example
{ "code": "runtime.failure", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: audit.response-unavailable, service.unavailable.
object
Example
{ "code": "audit.response-unavailable", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}Headers
Section titled “Headers”Whole seconds to wait before trying again.
Cookies on Registry Stack
We use optional cookies to understand how you use the main Registry Stack website and this documentation. If you contact us, we may link this activity to your enquiry. You can change your choice at any time. Read the privacy policy.
Your browser asks sites not to track you, so optional tracking stays off.
We could not use or save that choice. Optional tracking remains off.