> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Ironclad

The Ironclad connector lets your AI agent act in each user's Ironclad account. Each user signs in to Ironclad once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 27 tools.

**Authentication:** OAuth 2.0
**Categories:** Productivity, Files & Documents
**Tools:** 27: 16 read, 9 write, 2 destructive
**Users sign in with:** OAuth
**OAuth app:** Your own Ironclad app
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=IRONCLAD)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Ironclad connection

   In **AgentKit > Connections**, create an Ironclad connection and copy its redirect URI. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Register an OAuth app

   Ironclad connections use your own OAuth app. Register one with Ironclad and add the redirect URI you copied.

   Then enter the app's Client ID and Client Secret on the Ironclad connection.

5. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'ironclad'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Ironclad:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'ironclad_obligations_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "ironclad"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Ironclad:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="ironclad_obligations_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user signs in once. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'ironclad_obligation_get',
  toolInput: {
    obligation_id: '<obligation_id>',
  },
  connector: 'ironclad',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="ironclad_obligation_get",
    tool_input={
        "obligation_id": "<obligation_id>",
    },
    connection_name="ironclad",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `ironclad_obligation_get`

Get Obligation · Read-only

Get one contract obligation.
Returns id, name, type, status, description, due date, recurrence, owner and source record.
Use ironclad_obligation_get with an ID from ironclad_obligations_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `obligation_id` (`string`, required): Obligation ID or Ironclad ID. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f

Example input: `{"obligation_id":"<obligation_id>"}`

### `ironclad_obligations_list`

List Obligations · Read-only

List contract obligations, filtered by a formula or free text, sorted and paged.
Returns page, pageSize, count and list[] of obligations with id, name, type, status, due date, owner and source record.
Use ironclad_obligations_list to track contract commitments. Use ironclad_obligation_get for one obligation.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): Filter formula. Put the property ID in brackets and the value in single quotes. Example: Equals([status], 'open')
- `include` (`string`, optional): Set to occurrences to add each obligation's first 5 occurrences and occurrenceCount. Example: occurrences. One of: `occurrences`.
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50
- `search` (`string`, optional): Free-text search across obligation properties. Example: renewal
- `sort_direction` (`string`, optional): ASC or DESC (default). Example: ASC. One of: `ASC`, `DESC`.
- `sort_field` (`string`, optional): Sort by name (default) or lastUpdated. Example: lastUpdated. One of: `name`, `lastUpdated`.

Example input: `{}`

### `ironclad_record_get`

Get Record · Read-only

Get one contract record with its properties, links, parent, children and attachments.
Returns id, ironcladId, type, name, properties, attachments, links, parent and children.
Use ironclad_record_get for one record. Use ironclad_records_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `record_id` (`string`, required): Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
- `address_as_object` (`boolean`, optional): true returns address properties as objects instead of strings. Example: false
- `hydrate_entities` (`boolean`, optional): true returns related entities fully hydrated; false (default) returns minimal references. Example: false

Example input: `{"record_id":"<record_id>"}`

### `ironclad_records_list`

List Records · Read-only

List contract records in the repository, filtered by type, last update, a filter formula or free text, sorted and paged.
Returns page, pageSize, count and list[] of records with id, ironcladId, type, name, properties, links, parent and children.
Use ironclad_records_list to search the contract repository. Use ironclad_record_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address_as_object` (`boolean`, optional): true returns address properties as objects instead of strings. Example: false
- `filter` (`string`, optional): Filter formula. Put the property ID in brackets and the value in single quotes. Example: Equals([counterpartyName], 'Acme Inc')
- `hydrate_entities` (`boolean`, optional): true returns related entities fully hydrated; false (default) returns minimal references. Example: false
- `last_updated` (`string`, optional): Only records updated since this UTC date-time. Example: 2026-11-01T00:00:00Z
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50
- `search` (`string`, optional): Free-text search across all record properties. Example: Acme
- `sort_direction` (`string`, optional): ASC or DESC (default). Example: DESC. One of: `ASC`, `DESC`.
- `sort_field` (`string`, optional): Sort by agreementDate (default), name or lastUpdated. Example: lastUpdated. One of: `agreementDate`, `name`, `lastUpdated`.
- `types` (`string`, optional): Comma-separated record types, no spaces (see ironclad_records_schema_get). Example: contract,nda

Example input: `{}`

### `ironclad_records_schema_get`

Get Records Schema · Read-only

Get the repository's record types and record properties.
Returns recordTypes (ID, display name) and properties (ID, type, display name).
Use ironclad_records_schema_get to learn type and property IDs before ironclad_record_create, ironclad_record_update or a records filter.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `ironclad_workflow_approvals_list`

List Workflow Approvals · Read-only

List the approval groups and approver roles triggered on a workflow.
Returns workflowId, title, approvalGroups[] with each role's id, displayName, assignees and status.
Use ironclad_workflow_approvals_list to get the role ID for ironclad_workflow_approval_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_comments_list`

List Workflow Comments · Read-only

List comments in a workflow's activity feed.
Returns page, pageSize, count and list[] of comments with id, author, message, timestamp and replies.
Use ironclad_workflow_comments_list to read discussion. Use ironclad_workflow_comment_create to add a comment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_documents_list`

List Workflow Documents · Read-only

List the documents on a workflow, split into those included in and excluded from the signature packet.
Returns document entries with key, filename, version and download path.
Use ironclad_workflow_documents_list to see a workflow's files. Downloading the file bytes is not covered.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_get`

Get Workflow · Read-only

Get one workflow with all of its attributes.
Returns id, ironcladId, title, template, status, step, creator, attributes (field values), roles, approvals summary and documents.
Use ironclad_workflow_get to read field values before ironclad_workflow_attributes_update. Use ironclad_workflows_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `hydrate_entities` (`boolean`, optional): true returns related entities fully hydrated; false (default) returns minimal references. Example: false

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_participants_list`

List Workflow Participants · Read-only

List the users participating in a workflow.
Returns page, pageSize, count and list[] of participants with userId and email.
Use ironclad_workflow_participants_list to see who is on a workflow. Use ironclad_workflow_signers_list for signers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `email` (`string`, optional): Only the participant with this email. Example: jane.doe@example.com
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_schema_get`

Get Workflow Schema · Read-only

Get the launch-form fields of one workflow template.
Returns id, name and schema with each field's ID, type, display name and whether it is required.
Use ironclad_workflow_schema_get before ironclad_workflow_create to know which attributes to send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template ID (from ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7
- `form` (`string`, optional): Form to describe. Only launch is supported. Example: launch. One of: `launch`. Default: `launch`.

Example input: `{"template_id":"<template_id>"}`

### `ironclad_workflow_schemas_list`

List Workflow Schemas · Read-only

List workflow templates with the launch-form fields each one takes.
Returns list[] of schemas with id (the template ID), name and schema (field IDs, types and display names).
Use ironclad_workflow_schemas_list to pick a template. Use ironclad_workflow_schema_get for one template.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form` (`string`, required): Form to describe. Only launch is supported. Example: launch. One of: `launch`. Default: `launch`.

Example input: `{"form":"launch"}`

### `ironclad_workflow_sign_status_get`

Get Sign Step Status · Read-only

Get the sign-step status of a workflow that is in the Sign step.
Returns the signature packet state, provider and each signer's status.
Use ironclad_workflow_sign_status_get before ironclad_workflow_signer_remind; it fails if the workflow is not in the Sign step.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_signers_list`

List Workflow Signers · Read-only

List a workflow's signers and the status of each signature.
Returns signers[] with role name, name, email and signature status.
Use ironclad_workflow_signers_list for signature progress. Use ironclad_workflow_sign_status_get for the sign step's packet details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_turn_history_get`

Get Workflow Turn History · Read-only

Get the turn history of a workflow: who held the document during negotiation and when it changed hands.
Returns page, pageSize, count and list[] of turns with the party, user and timestamps.
Use ironclad_workflow_turn_history_get to see negotiation progress. Use ironclad_workflow_comments_list for discussion.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50

Example input: `{"workflow_id":"<workflow_id>"}`

### `ironclad_workflows_list`

List Workflows · Read-only

List workflows in the Ironclad account, filtered by status, template, last update, a filter formula or free text, one page at a time.
Returns page, pageSize, count (total matches) and list[] of workflows with id, ironcladId, title, template, status, step and attributes.
Use ironclad_workflows_list to find workflows. Use ironclad_workflow_get for one workflow's full attributes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): Filter formula. Put the attribute ID in brackets and the value in single quotes. Example: Equals([counterpartyName], 'Acme Inc')
- `hydrate_entities` (`boolean`, optional): true returns related entities fully hydrated; false (default) returns minimal references. Example: false
- `last_updated` (`string`, optional): Only workflows updated since this UTC date-time. Example: 2026-11-01T00:00:00Z
- `page` (`integer`, optional): Zero-based page number. Example: 0
- `page_size` (`integer`, optional): Results per page (default 20, maximum 100). Example: 50
- `search` (`string`, optional): Free-text search across all workflow properties, like the in-app search. Example: Acme
- `status` (`string`, optional): Comma-separated statuses: active, paused, completed, cancelled. Omit for active workflows (Create, Review, Sign and Archive steps). Example: active,completed
- `template` (`string`, optional): Only workflows from this template ID (see ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7

Example input: `{}`

### `ironclad_record_create`

Create Record · Write

Create a contract record in the repository with its type, name and property values.
Returns the created record with id and ironcladId.
Use ironclad_record_create to add an existing contract to the repository. Use ironclad_workflow_create to start a new contract process.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Record name. Example: Acme Inc - Master Services Agreement
- `properties` (`object`, required): Property values keyed by property ID. Each value is an object with type and value, where type matches the schema (for example string, number, boolean, date or monetary_amount). Example: {"counterpartyName": {"type": "string", "value": "Acme Inc"}, "agreementDate": {"type": "date", "value": "2026-11-01T00:00:00Z"}}
- `type` (`string`, required): Record type ID (from ironclad_records_schema_get). Example: contract
- `address_as_object` (`boolean`, optional): true returns address properties as objects instead of strings. Example: false
- `children` (`array`, optional): Child records, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
- `links` (`array`, optional): Records to link to, each {"recordId": "..."}. Example: [{"recordId": "6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f"}]
- `parent` (`object`, optional): Parent record, as {"recordId": "..."}. Example: {"recordId": "6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f"}

Example input: `{"name":"<name>","properties":{},"type":"<type>"}`

### `ironclad_record_update`

Update Record · Write

Update a record: rename it, change its type, add or remove properties, and add or remove links.
Returns the updated record.
Use ironclad_record_update to edit metadata on an existing record. Use ironclad_record_get first to see property IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `record_id` (`string`, required): Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
- `add_links` (`array`, optional): Records to link, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
- `add_properties` (`object`, optional): Properties to add or overwrite, keyed by property ID, each {type, value}. Example: {"counterpartyName": {"type": "string", "value": "Acme Corp"}}
- `address_as_object` (`boolean`, optional): true returns address properties as objects instead of strings. Example: false
- `name` (`string`, optional): New record name. Example: Acme Inc - MSA (amended)
- `remove_links` (`array`, optional): Record links to remove, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
- `remove_properties` (`array`, optional): Property IDs to remove. Example: ["agreementExpirationDate"]
- `type` (`string`, optional): New record type ID. Example: contract

Example input: `{"record_id":"<record_id>"}`

### `ironclad_workflow_approval_update`

Update Workflow Approval · Write

Approve, or reset to pending, one approver role on a workflow as the connected user.
Returns the updated approval status.
Use ironclad_workflow_approval_update with a role ID from ironclad_workflow_approvals_list; the connected user must be assigned to that role.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `role_id` (`string`, required): Approver role ID (from ironclad_workflow_approvals_list). Example: legalApproval
- `status` (`string`, required): New approval status: approved or pending. Example: approved. One of: `approved`, `pending`.
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"role_id":"<role_id>","status":"approved","workflow_id":"<workflow_id>"}`

### `ironclad_workflow_attributes_update`

Update Workflow Attributes · Write

Set or clear attribute values on an in-progress workflow; read-only fields cannot change.
Returns the updated workflow.
Use ironclad_workflow_attributes_update to change field values. Use ironclad_workflow_get first to see attribute IDs and current values.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `updates` (`array`, required): Changes to apply. Each item has action (set or remove), path (the attribute ID) and, for set, value typed like the field. Example: [{"action": "set", "path": "counterpartyName", "value": "Acme Inc"}]
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `comment` (`string`, optional): Comment explaining the change, shown in the activity feed. Example: Corrected counterparty name

Example input: `{"updates":[{"action":"set","path":"counterpartyName","value":"Acme Inc"}],"workflow_id":"<workflow_id>"}`

### `ironclad_workflow_comment_create`

Create Workflow Comment · Write

Post a comment, or a reply to a comment, in a workflow's activity feed; mentioned users are notified.
Returns the created comment.
Use ironclad_workflow_comment_create to discuss a workflow. Use ironclad_workflow_comments_list to find a comment ID to reply to.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `comment` (`string`, required): Comment text. Mention a user with <@john.doe@example.com>. Example: <@jane.doe@example.com> please review the payment terms
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
- `add_users_to_workflow` (`boolean`, optional): Set true when mentioning users who are not yet participants, to add them. Example: false
- `replied_to_message_id` (`string`, optional): ID of the comment to reply to (from ironclad_workflow_comments_list). Example: 64f0c1a2b3c4d5e6f7a8b9c0

Example input: `{"comment":"<comment>","workflow_id":"<workflow_id>"}`

### `ironclad_workflow_create`

Create Workflow · Write

Launch a new workflow from a template with its launch-form attributes; the call waits until the workflow exists.
Returns the new workflow with id, ironcladId, title, status, step and attributes.
Use ironclad_workflow_create after ironclad_workflow_schema_get shows the template's fields. Use ironclad_record_create to store an executed contract without a workflow.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `attributes` (`object`, required): Launch-form field values keyed by attribute ID, typed as the template schema says (strings, numbers, booleans, dates, email lists, monetary amounts). Documents generated by the template need no file. Example: {"counterpartyName": "Acme Inc", "paperSource": "Our paper", "draft": [{"version": "1"}]}
- `template` (`string`, required): ID of the workflow template to launch (from ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7
- `use_default_values` (`boolean`, optional): true fills fields you leave out with the launch form's default values. Example: true

Example input: `{"attributes":{},"template":"<template>"}`

### `ironclad_workflow_pause`

Pause Workflow · Write

Pause an active workflow with a comment explaining why.
Returns no content (HTTP 204) when paused.
Use ironclad_workflow_pause to hold a workflow. Use ironclad_workflow_resume to continue it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `comment` (`string`, required): Comment explaining the action; it is added to the workflow's activity feed. Mention a user with <@user@example.com>. Example: Paused while legal reviews the indemnity clause
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"comment":"<comment>","workflow_id":"<workflow_id>"}`

### `ironclad_workflow_resume`

Resume Workflow · Write

Resume a paused workflow with a comment.
Returns no content (HTTP 204) when resumed.
Use ironclad_workflow_resume on a workflow paused with ironclad_workflow_pause.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `comment` (`string`, required): Comment explaining the action; it is added to the workflow's activity feed. Mention a user with <@user@example.com>. Example: Paused while legal reviews the indemnity clause
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"comment":"<comment>","workflow_id":"<workflow_id>"}`

### `ironclad_workflow_signer_remind`

Remind Signer · Write

Email a reminder to one signer whose signature is still outstanding.
Returns no content (HTTP 204) when the reminder is sent.
Use ironclad_workflow_signer_remind after the packet is out for signature; get role names from ironclad_workflow_signers_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `signer_role_name` (`string`, required): Role name of the signer to remind, URL-encoded if it has spaces. Example: counterpartySigner
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"signer_role_name":"<signer_role_name>","workflow_id":"<workflow_id>"}`

### `ironclad_record_delete`

Delete Record · Destructive

Permanently delete a record from the repository.
Returns no content (HTTP 204) when deleted.
Use ironclad_record_delete only to remove a record for good; confirm the ID with ironclad_record_get first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `record_id` (`string`, required): Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f

Example input: `{"record_id":"<record_id>"}`

### `ironclad_workflow_cancel`

Cancel Workflow · Destructive

Cancel a workflow; it stops and cannot be resumed.
Returns no content (HTTP 204) when cancelled.
Use ironclad_workflow_cancel to end a workflow for good. Use ironclad_workflow_pause to stop it temporarily.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `comment` (`string`, required): Comment explaining the action; it is added to the workflow's activity feed. Mention a user with <@user@example.com>. Example: Paused while legal reviews the indemnity clause
- `workflow_id` (`string`, required): Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6

Example input: `{"comment":"<comment>","workflow_id":"<workflow_id>"}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
