Ironclad Workflows API
Documentation on Ironclad Workflows.
Ironclad Workflows API is one of 13 APIs that Ironclad publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 5 JSON Schema definitions.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 5 JSON Schemas.
This API exposes 43 operations across 38 paths, and defines 56 schemas. It is described by OpenAPI 3.1.0, at version 1.
Requests are made against 3 base URLs: https://na1.ironcladapp.com/oauth, https://eu1.ironcladapp.com/oauth, https://demo.ironcladapp.com/oauth.
43 operations
38 paths
56 schemas
2 DELETE19 GET7 PATCH15 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 43
Across 38 paths, the API surfaces 43 operations — 2 DELETE, 19 GET, 7 PATCH, 15 POST. Each is listed below with its method, path, parameters, and response codes.
Workflows 43
Documentation on Ironclad Workflows.
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}/commentdeprecated
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
Schemas 56
The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are LaunchedWorkflow (18 properties), WorkflowResponseModel (18 properties), OutboundActivityFeedEmail (10 properties), ActivityFeedComment (9 properties). Each schema is shown below with its type and property counts.
SignStatusModel
object
6 properties
ParentRecordAttributeModel
object
A parent record attribute value. Contains the record ID and readable ID of the parent record.
2 properties
WorkflowResponseModel
object
The response from a successful workflow retrieval.
18 properties
15 required
AddUsersToWorkflowModel
boolean
Must be set to true if mentioning users who are not participants on the workflow.
ExternalAssignment
object
2 properties
2 required
FileUploadModel
NotOnSignStep400
object
2 properties
WorkflowRoleAssigneeModel
object
3 properties
WorkflowNotFound
object
Workflow ID Not Found Request Error
3 properties
AttachmentNotFound
object
attachmentId Not Found Request Error
3 properties
InternalActivityFeedAuthor
object
An internal author of an activity feed item
5 properties
2 required
BaseSignStatusSigner
object
7 properties
4 required
LaunchedWorkflow
object
The response from a successful workflow launch.
18 properties
15 required
CommentModel
object
2 properties
1 required
SignStatusInternalSigner
WorkflowDocumentModel
object
6 properties
5 required
EmailNotFound
object
Email ID Not Found Request Error
3 properties
ActivityFeedAuthor
object
The author of an activity feed item
IntegrationActivityFeedAuthor
object
An integration author of an activity feed item
2 properties
2 required
InternalAssignment
object
2 properties
2 required
ExternalActivityFeedAuthor
object
An external author of an activity feed item (typically a counterparty)
4 properties
2 required
WorkflowSchemasLinkedRecordAttribute
object
A linked record schema attribute.
4 properties
SignatureStatusModel
object
1 property
ChildRecordAttributeModel
object
A child record attribute value. Contains the record ID and readable ID of the child record.
2 properties
SignedDocumentResponseModel
object
WorkflowRoleModel
object
3 properties
WorkflowSchemasResponseOptionsField
object
Defines the options for a field, including dropdown choices and whether free text input is allowed.
2 properties
2 required
SignStatusExternalSigner
BadRequestErrorWorkflowLaunch
object
3 properties
3 required
AttributesModel
object
The data that will be used to populate the workflow's fields. Learn more about the various attributes and their associated types by viewing the [Launch a Workf…
6 properties
1 required
PartialSignedResponse200
object
4 properties
LinkedRecordAttributeModel
object
A linked record attribute value. Contains the record ID and readable ID of the linked record.
2 properties
WorkflowSchemasResponseDefaultField
Defines the available default value for a field. In the case of multiple instances of the same property, the last evaluated default will be used.
CreatorEmailModel
object
The Ironclad user (must be a user in your Ironclad account) used to launch the workflow by using the user's email address.
2 properties
ActivityFeedEmail
object
A email-type item on the workflow activity feed
InboundEmailAttachment
object
An attachment on an inbound email
5 properties
2 required
WorkflowLaunchModel
object
Note that creator is required when launching with a legacy bearer token but will be ignored when launching via an OAuth token. If the token was generated with…
3 properties
2 required
OutboundEmailAttachment
object
An attachment on an outbound email
5 properties
3 required
WorkflowTemplateIdModel
string
The identifier of the workflow template
AttributeStringModel
string
WorkflowSchemasChildRecordAttribute
object
A child record schema attribute. The referenced record must not already have a parent.
4 properties
OutboundActivityFeedEmail
object
An outbound email-type item on the workflow activity feed
10 properties
4 required
WorkflowAsyncLaunchFailedResponse
object
3 properties
3 required
CreatorModel
object
The Ironclad user (must be a user in your Ironclad account) to be used for launching the workflow. This is required when using a legacy bearer token but will b…
InboundActivityFeedEmail
object
An inbound email-type item on the workflow activity feed
8 properties
5 required
AttributeNumberModel
number
WorkflowLaunchMultipartModel
object
Note that creator is required when launching with a legacy bearer token but will be ignored when launching via an OAuth token. If the token was generated with…
1 property
WorkflowSchemasParentRecordAttribute
object
A parent record schema attribute.
4 properties
SystemActivityFeedAuthor
object
A system author of an activity feed item
2 properties
2 required
WorkflowAsyncLaunchSuccessResponse
object
Response for a successfully asynchronously launched workflow.
4 properties
4 required
SignedResponse200
object
3 properties
ActivityFeedComment
object
A comment-type item on the workflow activity feed
9 properties
7 required
WorkflowSchemasResponseRequiredField
string
Indicates whether the field is required. Possible values are 'always', 'never', or 'conditional'. Conditional properties are either gated by a condition on the…
WorkflowAsyncInProgressResponse
object
2 properties
2 required
CreatorIdModel
object
The Ironclad user (must be a user in your Ironclad account) used to launch the workflow by using the user's ID.
2 properties
WorkflowStateModel
object
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ironclad 12
Other APIs Ironclad publishes across the network.
Ironclad Clickwrap API
Ironclad Authorization API
Ironclad Entities API
Ironclad Exports API
Ironclad Groups API
Ironclad Obligations API
Ironclad Records API
Ironclad Resources API
Ironclad Schemas API
Ironclad Search API
Ironclad Users API
Ironclad Webhooks API
#Workflows