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.
- Tools
- 27
- What they doRead · write · destructive
- 16 · 9 · 216 read9 write2 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Ironclad app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Ironclad connection
In AgentKit > Connections, create an Ironclad connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.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.
Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'ironclad'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'ironclad_obligations_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "ironclad"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="ironclad_obligations_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolironclad_obligation_getGet one contract obligation.Read-onlyGet Obligation
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.
Inputs
obligation_idstringrequired- Obligation ID or Ironclad ID. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
ironclad_obligations_listList contract obligations, filtered by a formula or free text, sorted and paged.Read-onlyList Obligations
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.
Inputs
filterstring- Filter formula. Put the property ID in brackets and the value in single quotes. Example: Equals([status], 'open')
includestring- Set to occurrences to add each obligation's first 5 occurrences and occurrenceCount. Example: occurrencesone of
occurrences pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
searchstring- Free-text search across obligation properties. Example: renewal
sort_directionstring- ASC or DESC (default). Example: ASCone of
ASCDESC sort_fieldstring- Sort by name (default) or lastUpdated. Example: lastUpdatedone of
namelastUpdated
ironclad_record_getGet one contract record with its properties, links, parent, children and attachments.Read-onlyGet Record
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.
Inputs
record_idstringrequired- Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
address_as_objectboolean- true returns address properties as objects instead of strings. Example: false
hydrate_entitiesboolean- true returns related entities fully hydrated; false (default) returns minimal references. Example: false
ironclad_records_listList contract records in the repository, filtered by type, last update, a filter formula or free text, sorted and paged.Read-onlyList Records
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.
Inputs
address_as_objectboolean- true returns address properties as objects instead of strings. Example: false
filterstring- Filter formula. Put the property ID in brackets and the value in single quotes. Example: Equals([counterpartyName], 'Acme Inc')
hydrate_entitiesboolean- true returns related entities fully hydrated; false (default) returns minimal references. Example: false
last_updatedstring- Only records updated since this UTC date-time. Example: 2026-11-01T00:00:00Z
pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
searchstring- Free-text search across all record properties. Example: Acme
sort_directionstring- ASC or DESC (default). Example: DESCone of
ASCDESC sort_fieldstring- Sort by agreementDate (default), name or lastUpdated. Example: lastUpdatedone of
agreementDatenamelastUpdated typesstring- Comma-separated record types, no spaces (see ironclad_records_schema_get). Example: contract,nda
ironclad_records_schema_getGet the repository's record types and record properties.Read-onlyGet Records Schema
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.
Inputs
This tool takes no inputs.
ironclad_workflow_approvals_listList the approval groups and approver roles triggered on a workflow.Read-onlyList Workflow Approvals
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_comments_listList comments in a workflow's activity feed.Read-onlyList Workflow Comments
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
ironclad_workflow_documents_listList the documents on a workflow, split into those included in and excluded from the signature packet.Read-onlyList Workflow Documents
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_getGet one workflow with all of its attributes.Read-onlyGet Workflow
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
hydrate_entitiesboolean- true returns related entities fully hydrated; false (default) returns minimal references. Example: false
ironclad_workflow_participants_listList the users participating in a workflow.Read-onlyList Workflow Participants
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
emailstring- Only the participant with this email. Example: jane.doe@example.com
pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
ironclad_workflow_schema_getGet the launch-form fields of one workflow template.Read-onlyGet Workflow Schema
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.
Inputs
template_idstringrequired- Template ID (from ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7
formstring- Form to describe. Only launch is supported. Example: launchone of
launchdefaultlaunch
ironclad_workflow_schemas_listList workflow templates with the launch-form fields each one takes.Read-onlyList Workflow Schemas
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.
Inputs
formstringrequired- Form to describe. Only launch is supported. Example: launchone of
launchdefaultlaunch
ironclad_workflow_sign_status_getGet the sign-step status of a workflow that is in the Sign step.Read-onlyGet Sign Step Status
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_signers_listList a workflow's signers and the status of each signature.Read-onlyList Workflow Signers
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_turn_history_getGet the turn history of a workflow: who held the document during negotiation and when it changed hands.Read-onlyGet Workflow Turn History
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.
Inputs
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
ironclad_workflows_listList workflows in the Ironclad account, filtered by status, template, last update, a filter formula or free text, one page at a time.Read-onlyList Workflows
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.
Inputs
filterstring- Filter formula. Put the attribute ID in brackets and the value in single quotes. Example: Equals([counterpartyName], 'Acme Inc')
hydrate_entitiesboolean- true returns related entities fully hydrated; false (default) returns minimal references. Example: false
last_updatedstring- Only workflows updated since this UTC date-time. Example: 2026-11-01T00:00:00Z
pageinteger- Zero-based page number. Example: 0
page_sizeinteger- Results per page (default 20, maximum 100). Example: 50
searchstring- Free-text search across all workflow properties, like the in-app search. Example: Acme
statusstring- Comma-separated statuses: active, paused, completed, cancelled. Omit for active workflows (Create, Review, Sign and Archive steps). Example: active,completed
templatestring- Only workflows from this template ID (see ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7
ironclad_record_createCreate a contract record in the repository with its type, name and property values.WriteCreate Record
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.
Inputs
namestringrequired- Record name. Example: Acme Inc - Master Services Agreement
propertiesobjectrequired- 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"}}
typestringrequired- Record type ID (from ironclad_records_schema_get). Example: contract
address_as_objectboolean- true returns address properties as objects instead of strings. Example: false
childrenarray- Child records, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
linksarray- Records to link to, each {"recordId": "..."}. Example: [{"recordId": "6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f"}]
parentobject- Parent record, as {"recordId": "..."}. Example: {"recordId": "6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f"}
ironclad_record_updateUpdate a record: rename it, change its type, add or remove properties, and add or remove links.WriteUpdate Record
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.
- Idempotent
Inputs
record_idstringrequired- Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
add_linksarray- Records to link, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
add_propertiesobject- Properties to add or overwrite, keyed by property ID, each {type, value}. Example: {"counterpartyName": {"type": "string", "value": "Acme Corp"}}
address_as_objectboolean- true returns address properties as objects instead of strings. Example: false
namestring- New record name. Example: Acme Inc - MSA (amended)
remove_linksarray- Record links to remove, each {"recordId": "..."}. Example: [{"recordId": "7a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"}]
remove_propertiesarray- Property IDs to remove. Example: ["agreementExpirationDate"]
typestring- New record type ID. Example: contract
ironclad_workflow_approval_updateApprove, or reset to pending, one approver role on a workflow as the connected user.WriteUpdate Workflow Approval
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.
- Idempotent
Inputs
role_idstringrequired- Approver role ID (from ironclad_workflow_approvals_list). Example: legalApproval
statusstringrequired- New approval status: approved or pending. Example: approvedone of
approvedpending workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_attributes_updateSet or clear attribute values on an in-progress workflow; read-only fields cannot change.WriteUpdate Workflow Attributes
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.
- Idempotent
Inputs
updatesarrayrequired- 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_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
commentstring- Comment explaining the change, shown in the activity feed. Example: Corrected counterparty name
ironclad_workflow_comment_createPost a comment, or a reply to a comment, in a workflow's activity feed; mentioned users are notified.WriteCreate Workflow Comment
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.
Inputs
commentstringrequired- Comment text. Mention a user with <@john.doe@example.com>. Example: <@jane.doe@example.com> please review the payment terms
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
add_users_to_workflowboolean- Set true when mentioning users who are not yet participants, to add them. Example: false
replied_to_message_idstring- ID of the comment to reply to (from ironclad_workflow_comments_list). Example: 64f0c1a2b3c4d5e6f7a8b9c0
ironclad_workflow_createLaunch a new workflow from a template with its launch-form attributes; the call waits until the workflow exists.WriteCreate Workflow
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.
Inputs
attributesobjectrequired- 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"}]}
templatestringrequired- ID of the workflow template to launch (from ironclad_workflow_schemas_list). Example: 6438a3e5c3f6a1b2c3d4e5f7
use_default_valuesboolean- true fills fields you leave out with the launch form's default values. Example: true
ironclad_workflow_pausePause an active workflow with a comment explaining why.WritePause Workflow
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.
Inputs
commentstringrequired- 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_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_resumeResume a paused workflow with a comment.WriteResume Workflow
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.
Inputs
commentstringrequired- 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_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_workflow_signer_remindEmail a reminder to one signer whose signature is still outstanding.WriteRemind Signer
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.
Inputs
signer_role_namestringrequired- Role name of the signer to remind, URL-encoded if it has spaces. Example: counterpartySigner
workflow_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
ironclad_record_deletePermanently delete a record from the repository.DestructiveDelete Record
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.
- Idempotent
Inputs
record_idstringrequired- Record ID or Ironclad ID of the record. Get it from ironclad_records_list. Example: 6f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f
ironclad_workflow_cancelCancel a workflow; it stops and cannot be resumed.DestructiveCancel Workflow
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.
Inputs
commentstringrequired- 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_idstringrequired- Workflow ID or Ironclad ID (e.g. IC-1234). Get it from ironclad_workflows_list. Example: 6438a3e5c3f6a1b2c3d4e5f6
No tools match.