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.2.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.
The identity and technical contract details declared by the specification.
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
EmailNotFound
object
Email ID Not Found Request Error
3 properties
InternalAssignment
object
2 properties
2 required
WorkflowRoleModel
object
3 properties
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
OutboundActivityFeedEmail
object
An outbound email-type item on the workflow activity feed
10 properties
4 required
WorkflowSchemasChildRecordAttribute
object
A child record schema attribute. The referenced record must not already have a parent.
4 properties
SignedDocumentResponseModel
object
WorkflowAsyncLaunchFailedResponse
object
3 properties
3 required
SignedResponse200
object
3 properties
AttributeNumberModel
number
WorkflowSchemasParentRecordAttribute
object
A parent record schema attribute.
4 properties
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
WorkflowSchemasResponseOptionsField
object
Defines the options for a field, including dropdown choices and whether free text input is allowed.
2 properties
2 required
ParentRecordAttributeModel
object
A parent record attribute value. Contains the record ID and readable ID of the parent record.
2 properties
AttributeStringModel
string
WorkflowAsyncInProgressResponse
object
2 properties
2 required
LaunchedWorkflow
object
The response from a successful workflow launch.
18 properties
15 required
AddUsersToWorkflowModel
boolean
Must be set to true if mentioning users who are not participants on the workflow.
AttachmentNotFound
object
attachmentId Not Found Request Error
3 properties
WorkflowNotFound
object
Workflow ID Not Found Request Error
3 properties
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…
WorkflowSchemasLinkedRecordAttribute
object
A linked record schema attribute.
4 properties
NotOnSignStep400
object
2 properties
OutboundEmailAttachment
object
An attachment on an outbound email
5 properties
3 required
ActivityFeedAuthor
object
The author of an activity feed item
WorkflowResponseModel
object
The response from a successful workflow retrieval.
18 properties
15 required
WorkflowTemplateIdModel
string
The identifier of the workflow template
BadRequestErrorWorkflowLaunch
object
3 properties
3 required
WorkflowRoleAssigneeModel
object
3 properties
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
InboundActivityFeedEmail
object
An inbound email-type item on the workflow activity feed
8 properties
5 required
BaseSignStatusSigner
object
7 properties
4 required
ActivityFeedEmail
object
A email-type item on the workflow activity feed
InboundEmailAttachment
object
An attachment on an inbound email
5 properties
2 required
SystemActivityFeedAuthor
object
A system author of an activity feed item
2 properties
2 required
SignStatusModel
object
6 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.
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
SignatureStatusModel
object
1 property
WorkflowAsyncLaunchSuccessResponse
object
Response for a successfully asynchronously launched workflow.
4 properties
4 required
LinkedRecordAttributeModel
object
A linked record attribute value. Contains the record ID and readable ID of the linked record.
2 properties
IntegrationActivityFeedAuthor
object
An integration author of an activity feed item
2 properties
2 required
WorkflowStateModel
object
InternalActivityFeedAuthor
object
An internal author of an activity feed item
5 properties
2 required
CommentModel
object
2 properties
1 required
ActivityFeedComment
object
A comment-type item on the workflow activity feed
9 properties
7 required
WorkflowDocumentModel
object
6 properties
5 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…
ChildRecordAttributeModel
object
A child record attribute value. Contains the record ID and readable ID of the child record.
2 properties
PartialSignedResponse200
object
4 properties
ExternalActivityFeedAuthor
object
An external author of an activity feed item (typically a counterparty)
4 properties
2 required
ExternalAssignment
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Ironclad publishes across the network.
