How to connect Ironclad to Claude

Activate a record and set its effective date, term, termination notice, expiration, and renewal behavior.

Cancel auto-renewal for a record.

Cancel a workflow, recording a comment that explains why.

Cancel the signature request (the signature packet sent to the signers) that is out for signature on a workflow, with a reason.

Start a data export job for workflow activity or the audit log, optionally limited to a date range; it does not wait for the file and returns a pollable job_id.

Create a signing link for one signer that is allowed to load inside a frame on the given parent site.

Create an entity (a counterparty or other party that contracts refer to) with a name and, optionally, a relationship type, status, parent and properties.

Create a standalone obligation on a contract record.

Record a new triggered occurrence of an existing source obligation.

Create a contract record in the repository with a record type, a name and metadata properties.

Upload a contract file and use Smart Import to create a record and predict its properties.

Post a comment to a workflow's activity feed as the connected user, optionally as a reply to another comment and with @-mentions.

Create a link that a signer, or a view-only recipient, can open to reach the workflow's signature request.

Delete an entity.

Delete an obligation.

Delete a contract record from the repository.

Remove one file from a contract record by its attachment key; the record itself stays.

Remove the scheduled send from a workflow, so its signature request (the signature packet for the signers) is no longer sent at the scheduled time.

Remove a signer from a workflow's signature packet.

Download the file of a finished data export job: CSV, or JSON Lines if the job was created with export_format JSON.

Download one file attached to a record by its attachment key; signedCopy is the key of the signed copy.

Download one document of a workflow by its document key: a draft (usually DOCX) or the signed PDF.

Download one file attached to an email thread of a workflow.

Edit a record's renewal type, term, opt-out timing, remaining renewal count, initial term, and expiration settings.

Create an Ironclad workflow-activity or audit-log data export job, poll its status with a bounded configurable wait, then download and return the completed CSV or JSON Lines file.

Download an XLSX spreadsheet of records for the record types and property columns you name.

Extend a record, optionally setting the renewal term length.

Check a data export job started with IRONCLAD_CREATE_DATA_EXPORT.

Get one entity by id or Ironclad id: its name, status, relationship type ids, parent and properties (each as {type, value}).

Get one obligation by id or Ironclad id: its name, parent contract, status, due date, assignee and properties (each as {type, value}), and whether it is a source obligation or an occurrence; a source obligation's occurrences are listed by IRONCLAD_LIST_OBLIGATION_INSTANCES.

Get one contract record by id or Ironclad id: its type, name, properties (each as {type, value}), attachments, links, parent and children, and contract status.

Get the record schema of the company's repository: the record type keys, every property id with its display name and type, and the attachment keys.

Check whether Smart Import has finished predicting properties, for one record (record_id) or for every record of an import (import_id); one of the two is required.

Get one workflow by id or Ironclad id: its step, status, roles, approvals, signatures, attribute values and the schema that types each attribute.

Get one comment of a workflow by its comment id, with author, time, mentions, the comment it replies to and reactions.

Get one email thread of a workflow by its email thread id.

Check a workflow launch started with IRONCLAD_LAUNCH_WORKFLOW using execution_mode async.

Get the launch-form schema of one workflow template: every attribute id with its type, display name, whether it is required (always, never or conditional) and its dropdown options.

Get the signing state of a workflow that is in the Sign step: signers and their status, routing order, the signature provider, whether a signed upload is required and any scheduled send.

Launch a workflow from a template.

Launch from an existing Coupa or Salesforce workflow sync mapping.

List the entities (counterparties and other parties) of the company, one page per call, optionally narrowed by free-text search or a formula and sorted.

List the entity relationship types the company has defined, such as customer or vendor, all in one call.

List the instances (occurrences) of one source obligation, by id or Ironclad id, one page per call, ordered by due date with undated instances last; every item has obligation_type OCCURRENCE.

List the source obligations of the company, one page per call, optionally narrowed by free-text search or a formula and sorted.

List the contract records in the repository, one page per call, optionally filtered by record type, update time, free-text search or a property formula, and sorted.

List the approval requests that have taken place on a workflow, one page per call: who was asked, when, the outcome and how long it took.

Get the current approvals of a workflow in one call (not paged): its approval groups with their order and each reviewer's status, and the workflow's roles with their ids, display names and assignees.

List the comments in a workflow's activity feed, one page per call, with author, time, mentions, replies and reactions.

List a workflow's documents in two groups, those in the signature packet and those left out of it, each with its document key, filename and version.

List the email threads of a workflow, one page per call.

List the users who participate in a workflow (user id and email), one page per call, optionally narrowed to one email.

List the users who may be assigned to one role of a workflow, one page per call, plus the role's default assignee where Ironclad returns one.

List the workflows the connected user can see, one page per call, optionally filtered by status, template, update time, free-text search or an attribute formula.

List the workflow templates that can be launched, with their launch-form schemas: each entry has the template id, name, the same launch-form schema IRONCLAD_GET_WORKFLOW_SCHEMA returns for one template (attribute ids, types, required, options) and what the connected user may do with it (permissions).

List the signers of a workflow with name, email, role name, signature status and delegates.

List the turn history of a workflow, one page per call: each turn names the party that held the workflow, the user, the location and the start and end times.

Pause an active workflow that is in the Review step, recording a comment that explains why; Ironclad documents that only active workflows in the Review step can be paused.

Only for an existing attribute source configuration, such as a Coupa or Salesforce workflow sync mapping: refresh a workflow from it.

Email a signer a reminder that their signature is needed.

Replace a record with a new type, name and complete set of properties.

Resume a workflow that was paused with IRONCLAD_PAUSE_WORKFLOW, recording a comment.

Move a workflow from the Sign step back to the Review step.

Schedule a workflow's signature request (the signature packet sent to the signers) to go out at a set time, optionally with a reminder email to the signature coordinator beforehand.

Send a workflow's signature request (the signature packet sent to the signers) out for signature now.

Mark a record as superseded on specified recorded and effective dates, optionally linking its replacement record.

Terminate a record on specified recorded and effective dates, optionally linking the record that caused termination.

Reverse a specified lifecycle action previously applied to a record.

Change selected parts of an entity: its name, relationship type, status, parent, and properties to add or remove.

Change an obligation's name, type or properties; send at least one field to change.

Change selected parts of a record and leave the rest as it is: add or overwrite properties, remove properties, rename it, change its type, and edit its links, parent and children.

Change the send time or the reminder of the signature request already scheduled on a workflow with IRONCLAD_SCHEDULE_WORKFLOW_SIGNATURE_REQUEST.

Approve a workflow on behalf of one approver role, or set that approval back to pending, as the user the connection acts as.

Set or clear attribute (form field) values on a workflow that is in the Review step, and return the updated workflow.

Assign a workflow role such as Archiver or Signature Coordinator to a different user.

Replace the ordered list of documents in a workflow's signature packet, the documents a signature request sends to the signers.

Reassign a signer role of a workflow to another signer, or change an external signer's name or email.

Attach a file to a contract record under an attachment key.

Upload a signed PDF to a workflow that is in the Sign step.

Upload a PDF or Word file into a document attribute of a workflow, with a required comment.