View as Markdown
Ironclad icon

Ironclad ACTION

Get Workflow

Retrieves the full Ironclad workflow object, including its schema and current attribute keys and types. Use the returned schema to construct a valid updates payload for Update Workflow Attributes. Run Search Workflows first to find a workflow ID. Example: set workflowId to "wf_xyz789" to retrieve a workflow with fields such as id, title, status, currentStep, and attributes (a map of attribute key → value). Use the optional fields param (e.g. "id,title,status") to return only specific top-level keys. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ironclad account once, then configure and run Get Workflow from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ironclad-get-workflow",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ironclad: { authProvisionId: "apn_xxxxxxx" },
    workflowId: "Workflow ID",
    hydrateEntities: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Workflow inputs
Property Type Description
workflowId Workflow ID string
The identifier of a workflow. Obtain via Search Workflows.
Required Dynamic
hydrateEntities Hydrate Entities boolean
Whether to expand referenced entities in the response. Defaults to false.
Optional
fields Fields string
Comma-separated list of top-level response keys to return (e.g. id,title,status). If omitted, the full response object is returned.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ironclad-get-workflow
Version
0.0.2
App
Ironclad
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes