Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Ironclad

Scalekit connector
Open markdown

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 app
Your own Ironclad app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  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.

  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

    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.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)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • ironclad_obligation_getGet one contract obligation.Read-only

    Get 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-only

    List 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-only

    Get 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-only

    List 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-only

    Get 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-only

    List 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-only

    List 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-only

    List 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