Skip to content
HeyCrustDocs

Search documentation

Search by topic or tool name
Partner portalOpen app ↗
Browse documentation
Tool reference

list_flow_runs

Returns runs with current saved status/step/wake information.

Verified ·Read Markdown
On this page

Purpose

Merchants moving through a flow (or one merchant's runs across flows): status, current step, next wake time, exit reason.

Credentials and scope

Owner workspace credential. The credential determines tool visibility. For tools with appId, use the HeyCrust app UUID from list_apps; the dashboard app selector does not supply MCP arguments for you.

Inputs

  • flowId: optional; string; format: uuid — Flow id from list_flows.
  • shopDomainOrInstallId: optional; string
  • limit: optional; integer; minimum: 1; maximum: 200; default: 50

Example request

The identifiers and merchant are fictional. Replace them with records returned for your own workspace; this example is schema-checked, not a promise that the fictional record exists.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_flow_runs",
    "arguments": {
      "flowId": "11111111-1111-4111-8111-111111111111",
      "limit": 50
    }
  }
}

POST this JSON to https://heycrust.com/api/mcp with Content-Type: application/json and Authorization: Bearer <YOUR_CREDENTIAL>. The tool result normally contains JSON encoded as text in result.content; inspect JSON-RPC errors and result.isError before using it.

Result

Returns runs with current saved status/step/wake information. Check the exact selected merchant/Flow when inspecting a workspace-wide result.

Effects and verification

Reads existing records or definitions. It does not create a payment or send a message. Verify the returned app/merchant identity and source coverage before interpreting the result.

Troubleshooting

A missing tool can mean that the credential lacks its catalog or required scopes. Invalid arguments are different from unavailable source data or a record outside the workspace. A handler can return a business error even when the argument schema is valid. Read MCP overview and Help.

Continue reading