Ironclad

Ironclad Workflows API

Documentation on Ironclad Workflows.

GitHub OpenAPI

Operations 43

POST /workflows Create a Workflow Synchronously #
GET /workflows List All Workflows #
POST /workflows/async Create a Workflow Asynchronously #
GET /workflows/async/{asyncJobId} Retrieve the Status of an Async Workflow Create Job #
GET /workflows/{id} Retrieve a Workflow #
GET /workflows/{id}/approvals List All Workflow Approvals #
GET /workflows/{id}/approval-requests Retrieve the Approval Requests on a Workflow #
PATCH /workflows/{id}/approvals/{roleId} Update Approval Status on a Workflow #
GET /workflows/{id}/turn-history Retrieve the Turn History on a Workflow #
GET /workflows/{id}/sign-status Retrieve Sign Step Status #
POST /workflows/{id}/sign-status/send-signature-request Send Signature Request #
POST /workflows/{id}/sign-status/scheduled-send Schedule Send Signature Request #
PATCH /workflows/{id}/sign-status/scheduled-send Update Scheduled Signature Request #
DELETE /workflows/{id}/sign-status/scheduled-send Delete Scheduled Signature Request #
POST /workflows/{id}/sign-status/cancel-signature-request Cancel Signature Request #
PATCH /workflows/{id}/sign-status/signers/{signerRoleName} Update Signer #
DELETE /workflows/{id}/sign-status/signers/{signerRoleName} Delete Signer #
POST /workflows/{id}/sign-status/signers/{signerRoleName}/remind Remind Signer #
GET /workflows/{id}/signatures List All Workflow Signers #
POST /workflows/{id}/signatures/recipient-urls Create a Recipient URL for a Signer #
POST /workflows/{id}/signatures/recipient-urls/embedded Create an Embeddable Recipient URL for a Signer #
POST /workflows/{id}/upload-signed Create a Signed Document on a Workflow #
GET /workflows/{id}/participants List All Workflow Participants #
PATCH /workflows/{id}/roles/{roleName} Update Workflow Role Assignment #
GET /workflows/{id}/roles/{roleName}/eligible-assignees List Eligible Assignees for a Workflow Role #
PATCH /workflows/{id}/revert-to-review Revert a Workflow to the Review Step #
POST /workflows/{id}/cancel Cancel a Workflow #
POST /workflows/{id}/pause Pause a Workflow #
POST /workflows/{id}/resume Resume a Workflow #
POST /workflows/{id}/comment Create a Comment on a Workflow #
POST /workflows/{id}/comments Create a Comment on a Workflow #
GET /workflows/{id}/comments List all Comments on a Workflow #
GET /workflows/{id}/comments/{commentId} List a Comment from a Specified Workflow #
PATCH /workflows/{id}/attributes Update Workflow Metadata #
GET /workflows/{id}/documents Retrieve Documents from a Workflow #
PATCH /workflows/{id}/signature-packet Update Signature Packet on a Workflow #
POST /workflows/{id}/documents/{attributeId} Create a Document on a Workflow #
GET /workflows/{id}/document/{key}/download Retrieve a Workflow Document #
GET /workflows/{id}/emails Retrieve Email Threads from A Workflow #
GET /workflows/{id}/emails/{emailThreadId} Retrieve an Email Thread from a Specified Workflow #
GET /workflows/{id}/emails/{emailThreadId}/attachments/{attachmentId} Retrieve an Attachment from an Email Thread #
GET /workflow-schemas List All Workflow Schemas #
GET /workflow-schemas/{id} Retrieve a Workflow Schema #

Documentation

📖
Documentation
https://developer.ironcladapp.com/reference/getting-started-api
📖
Authentication
https://developer.ironcladapp.com/reference/authenticate-a-request
📖
RateLimits
https://developer.ironcladapp.com/reference/clm-api-rate-limits
📖
Documentation
https://developer.ironcladapp.com/reference/authentication-api
📖
Documentation
https://developer.ironcladapp.com/reference/authorization-code-grant
📖
Documentation
https://developer.ironcladapp.com/reference/client-credentials-grant
📖
Documentation
https://developer.ironcladapp.com/reference/register-oauth-client
📖
Documentation
https://developer.ironcladapp.com/reference/guidance-for-oauth-migration
📖
Documentation
https://developer.ironcladapp.com/reference/retrieve-all-users

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/openapi/ironclad-workflows-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-schema/ironclad-workflow-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-schema/ironclad-record-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-schema/ironclad-entity-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-schema/ironclad-webhook-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-schema/ironclad-user-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/json-ld/ironclad-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/examples/ironclad-launch-workflow-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/examples/ironclad-create-record-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/examples/ironclad-create-webhook-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/examples/ironclad-conversational-search-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ironclad-workflows-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ironclad-workflows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ironclad Public Workflows API
  description: Documentation for Ironclad's REST API.
  contact:
    name: Ironclad Support
    email: support@ironcladapp.com
  version: '1'
servers:
- url: https://na1.ironcladapp.com/public/api/v1
  description: Production server
- url: https://eu1.ironcladapp.com/public/api/v1
  description: EU Production server
- url: https://demo.ironcladapp.com/public/api/v1
  description: Demo server
tags:


# --- truncated at 32 KB (203 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ironclad/refs/heads/main/openapi/ironclad-workflows-api-openapi.yml