Ironclad is an AI-powered contract lifecycle management (CLM) platform that helps legal and business teams create, negotiate, sign, and manage contracts at scale. Its Digital Contracting Platform spans the lifecycle — workflow automation, collaborative redlining, approval routing, eSignature, and a searchable repository. Its REST API exposes workflow data, contract records, approvals, and signing statuses.
Power end-to-end data operations for your Ironclad API with Nexla. Our bi-directional Ironclad connector is purpose-built for Ironclad, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Ironclad or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Ironclad workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
The Ironclad connector uses OAuth 2.0 (three-legged authorization code flow) to authenticate. Before creating a credential in Nexla, you must register an OAuth application in your Ironclad instance to obtain a Client ID and Client Secret.
Ironclad's API is an add-on feature. Before you can register an OAuth application, API access must be enabled for your Ironclad instance.
Contact your Ironclad Customer Success Manager to request that API access be enabled for your account. Once enabled, an API tab will appear in your Company Settings.
Once API access is enabled, follow these steps to create an OAuth application and obtain your credentials:
Sign in to your Ironclad instance (e.g., https://na1.ironcladapp.com).
Click your user profile avatar or name in the top-right corner of the screen, and select Company Settings from the dropdown menu.
In the left sidebar of Company Settings, click the API tab.
Click the Create new app button. A dialog will appear prompting you to enter a name for the OAuth application.
Enter a descriptive name for the application (e.g., "Nexla Integration"), then click Create app.
Ironclad will display your new application's Client ID and Client Secret. Copy and store both values in a secure location immediately—the Client Secret will not be shown again after you leave this page.
The Client Secret is shown only once at creation time. Store it securely (for example, in a password manager) before closing the dialog. If the secret is lost, you must delete the application and create a new one.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Ironclad instance base URL in the Ironclad Instance URL field. Use the regional base URL that matches your account (e.g., https://na1.ironcladapp.com for North America or https://eu1.ironcladapp.com for Europe). This value defaults to https://na1.ironcladapp.com.
Enter the Client ID obtained when registering your OAuth application in the Client ID field. This is the unique public identifier assigned to your Ironclad OAuth application.
Optionally, enter a space-separated list of OAuth scopes your application requests in the Access Scope field. Scopes control which Ironclad resources and actions Nexla is permitted to access on behalf of the authorizing user.
Consult the Ironclad API documentation for the list of available scopes and guidance on which scopes are required for the operations you intend to perform. If left blank, Ironclad will grant the default set of permissions associated with the authorizing user's account.
Enter the Client Secret obtained when registering your OAuth application in the Client Secret field. This private key authenticates your application when exchanging the authorization code for an access token and must be kept secure.
After entering all credential fields, Nexla will initiate the OAuth authorization flow. You will be redirected to your Ironclad instance to log in and authorize the application's access. After completing authorization, you will be returned to Nexla and the credential will be created with the issued access and refresh tokens.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Ironclad connector tile, then select the credential that will be used to connect to the Ironclad instance, and click Next; or, create a new Ironclad credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Ironclad endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
List All Workflows
Retrieves a paginated list of all workflows in your Ironclad instance, with optional filtering by status, template, last-updated timestamp, and custom filter criteria. Use this endpoint to pull workflow data for reporting, auditing, or downstream processing.
This endpoint returns a paginated list of workflow objects. Nexla automatically iterates through all pages to collect the complete dataset.
Optionally, enter a workflow status value in the Status field to filter results. Accepted values are active, paused, completed, and cancelled. Leave blank to retrieve workflows in all statuses.
Optionally, enter a workflow template name or ID in the Template field to limit results to workflows launched from that template.
Optionally, enter an ISO 8601 timestamp in the Last Updated field (e.g., 2024-01-01T00:00:00Z) to retrieve only workflows updated after that point in time.
Optionally, enter a custom filter expression in the Filter field to apply additional criteria. Refer to the Ironclad API reference for supported filter syntax.
Optionally, set Hydrate Entities to true to include full entity details (such as user objects) within the response, rather than returning only entity IDs.
Workflows are the core unit of Ironclad. Each workflow represents a business process and its associated contract — from initiation through review, approval, signing, and completion. For additional detail on workflow fields and filtering, see the List All Workflows reference in the Ironclad Developer Hub.
Retrieve a Workflow
Retrieves the full details of a single Ironclad workflow by its unique ID. Use this endpoint when you need complete metadata for a specific workflow, such as its current status, attributes, participants, and associated documents.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required. Workflow IDs can be found in the Ironclad UI or via the List All Workflows endpoint.
Optionally, set Hydrate Entities to true to expand entity references within the response (e.g., replace user IDs with full user objects).
This endpoint returns a single record — the full representation of the specified workflow. It is best suited for targeted lookups rather than bulk data retrieval.
Retrieve the Status of an Async Workflow Create Job
Checks the status of a previously initiated asynchronous workflow creation job. Use this endpoint to poll the result of a workflow created with the "Create a Workflow Asynchronously" destination endpoint.
Enter the job identifier returned by the asynchronous workflow creation call in the Job ID field. This value is required.
The response will indicate whether the job is still processing, has completed successfully, or has failed, along with any resulting workflow ID on success.
Async workflow creation is useful for scenarios where synchronous creation would exceed timeout limits, such as when launching workflows with large documents or complex launch forms. The Job ID is returned immediately from the async create call and should be stored for subsequent status polling.
List All Workflow Approvals
Retrieves all approvals (approval roles and their current statuses) for a specific workflow. Use this endpoint to monitor approval progress or audit approval decisions on a contract workflow.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The response includes each approval role defined in the workflow, along with its current status (e.g., pending, approved, rejected) and the approver details.
Retrieve the Approval Requests on a Workflow
Returns a paginated list of individual approval requests associated with a workflow. Unlike the approvals endpoint (which returns roles), this endpoint provides the individual approval request records, including decision timestamps and optional actor details.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
Optionally, set Actor Details to true to include full information about the users who made each approval decision.
Optionally, enter a value in the Request Type field to filter approval requests by type. Accepted values are:
role — returns approval requests assigned to roles
user — returns approval requests assigned to specific users
Retrieve Sign Step Status
Returns the signing status of a workflow that is currently in the Sign step. Use this endpoint to check which parties have signed, which are pending, and the overall signing progress for a specific contract workflow.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The response includes signing status information for all configured signers, including their signing state and any relevant timestamps.
List All Workflow Signers
Retrieves all signers configured for a specific workflow. Use this endpoint to see who is required to sign a contract and their current signing state.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The response includes each signer's identity information, role, and whether they have completed signing.
List All Workflow Participants
Retrieves a paginated list of all participants in a specific workflow, with optional filtering by email address. Participants include all users who have been assigned a role in the workflow, such as reviewers, approvers, and signers.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
Optionally, enter an email address in the Email Filter field to return only participants matching that address.
List All Comments on a Workflow
Retrieves all comments from a workflow's activity feed, with pagination. Use this endpoint to extract collaboration history, reviewer notes, or audit trail information associated with a specific workflow.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The response returns comment objects including the comment text, the author, and the timestamp at which each comment was posted.
Retrieve Documents from a Workflow
Returns all documents associated with a specific workflow, including contract documents and any supporting attachments. Use this endpoint to retrieve document metadata for workflows in any stage.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The response includes document metadata such as document ID, name, and type. Direct file download is handled separately via Ironclad's document download APIs.
List All Records
Retrieves a paginated, filterable list of all contract records stored in the Ironclad Repository. Records represent completed contracts and their associated metadata. Use this endpoint for bulk export, reporting, or synchronization with external systems such as vendor management platforms or data warehouses.
Optionally, enter a filter expression in the Filter Expression field to narrow the records returned. Refer to the Ironclad Records API documentation for supported filter syntax.
Optionally, enter one or more record type values in the Record Types field to filter by record type (e.g., vendor agreements, NDAs, SOWs).
Optionally, enter an ISO 8601 timestamp in the Last Updated field to retrieve only records updated after that point in time. This is useful for incremental data extraction.
Optionally, configure sorting using the following fields:
Sort Field: Enter the field name by which results should be sorted.
Sort Direction: Select ASC for ascending order or DESC for descending order.
Optionally, set Hydrate Entities to true to expand entity references (such as counterparty objects) within the response.
Optionally, set Address As Object to true to return address-type fields as structured objects (with street, city, state, and country sub-fields) rather than as plain strings.
The Ironclad Repository stores metadata and documents for all completed contracts. This endpoint is commonly used to synchronize contract data with vendor management systems, ERP platforms, or analytics tools. For more information, refer to the Ironclad Records documentation.
Retrieve a Record
Fetches the complete metadata for a single contract record by its unique ID. Use this endpoint for targeted lookups of specific contracts in the Ironclad Repository.
Enter the unique identifier of the record in the Record ID field. This value is required. Record IDs can be found via the List All Records endpoint or in the Ironclad UI.
Optionally, set Hydrate Entities to true to expand entity references within the response.
Optionally, set Address As Object to true to return address fields as structured objects rather than plain strings.
Retrieve Records Schema
Returns the schema for contract records in your Ironclad instance, including available record types and their properties. Use this endpoint to discover the structure of your Records data before building ingestion flows or data mappings.
No parameters are required for this endpoint. It returns the complete records schema, including all available record types and the fields defined for each type in your Ironclad configuration.
The schema is specific to your Ironclad instance and reflects any custom fields or record types your legal operations team has configured.
This endpoint is particularly useful when setting up data mapping or schema discovery in Nexla. Running it first helps you understand the available fields before configuring List All Records or Retrieve a Record data flows.
List All Workflow Schemas
Retrieves all workflow schemas from your Ironclad instance. A workflow schema describes the launch form fields for a specific workflow template, including field names, types, and validation rules. Use this endpoint to discover the structure of available workflow templates before building workflow creation flows.
No parameters are required. The endpoint returns a list of all available workflow schemas, one per active workflow template in your instance.
Retrieve a Workflow Schema
Returns the launch form schema for a specific workflow template. Use this endpoint to understand the required and optional fields for launching a particular type of workflow in Ironclad.
Enter the unique identifier of the workflow template in the Workflow Schema ID field. This value is required. Template IDs can be found using the List All Workflow Schemas endpoint.
The response includes the full schema definition for the template's launch form, including all field names, data types, and required/optional status.
Reviewing the workflow schema before building a "Create a Workflow" destination flow ensures that the data you are sending matches Ironclad's expected launch form structure. For guidance, see the Launch a Workflow guide in the Ironclad Developer Hub.
List All Users
Retrieves a paginated list of all users in your Ironclad instance via the SCIM 2.0 protocol. Use this endpoint to synchronize Ironclad user data with external identity management or HR systems.
Optionally, enter a SCIM filter expression in the Filter field to narrow the results (e.g., userName eq "john.doe@example.com").
Optionally, enter a comma-separated list of user attributes in the Excluded Attributes field to omit those attributes from the response, reducing payload size.
Ironclad's user management API follows the SCIM 2.0 standard. For the complete SCIM filter syntax and available user attributes, refer to the Ironclad Users API documentation.
List All Groups
Retrieves a paginated list of all groups in your Ironclad instance via the SCIM 2.0 protocol. Use this endpoint to synchronize Ironclad group membership data with external directory services or provisioning systems.
Optionally, enter a SCIM filter expression in the Filter field to narrow the results (e.g., displayName eq "Legal Team").
Optionally, enter a comma-separated list of group attributes in the Excluded Attributes field to omit those attributes from the response.
Ironclad's group management API follows the SCIM 2.0 standard. For additional details on filter syntax and group attributes, see the Ironclad Groups API documentation.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Ironclad data sources can also be manually configured to ingest data from any valid Ironclad API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Ironclad's public API base URL is your instance URL followed by /public/api/v1/ — for example, https://na1.ironcladapp.com/public/api/v1/workflows. User and group management endpoints use the SCIM 2.0 base path instead: https://na1.ironcladapp.com/scim/v2/.
Date/time macros are particularly useful with Ironclad's filtering parameters — for example, use {now-1} in a lastUpdated query parameter to incrementally fetch only records or workflows that have changed since the previous run. Lookup-based macros are useful for endpoints that require a specific Workflow ID or Record ID in the URL path, letting you iterate over a list of IDs pulled from another Nexla source.
Because Ironclad responses typically wrap list results inside a top-level object, set the path to data according to the endpoint type: $.list[*] for most list endpoints (workflows, records, participants, comments), $.Resources[*] for SCIM list endpoints (users, groups), and $ for single-resource endpoints (retrieve a workflow, retrieve a record). To attach top-level response fields such as total and pagination info to each record, set the Path to Metadata in Response field to $.
You do not need to include an Authorization header — Ironclad's OAuth 2.0 Bearer token is automatically included by Nexla based on your credential configuration.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Ironclad data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the Ironclad destination, and select the Send to Destination option from the menu. Select the Ironclad connector from the list of available destination connectors, then select the credential that will be used to connect to the Ironclad organization, and click Next; or, create a new Ironclad credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Ironclad endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Create a Workflow Synchronously
Launches a new Ironclad workflow and waits for the operation to complete before returning a response. Use this endpoint when you need immediate confirmation that a workflow was created and need the resulting workflow ID before proceeding.
The request body must be a valid Ironclad workflow launch payload in JSON format. The required fields depend on the workflow template's launch form schema. To review the expected fields for a specific template, use the Retrieve a Workflow Schema source endpoint first.
Each workflow payload must include the template ID and values for all required launch form fields defined by the template's schema. Optional fields can be omitted.
Optionally, configure the Use Default Values setting if your workflow template supports default field values and you wish to apply them when fields are not explicitly provided in the payload.
Synchronous workflow creation is best suited for lower-volume flows where immediate confirmation is needed. For high-volume scenarios or workflows with large documents, consider using the "Create a Workflow Asynchronously" template instead. For complete guidance on constructing the launch payload, refer to the Launch a Workflow guide in the Ironclad Developer Hub.
Create a Workflow Asynchronously
Initiates a new Ironclad workflow creation job asynchronously and immediately returns a job ID. Use this endpoint for high-volume workflow creation flows or when the workflow launch may take longer than a synchronous request timeout allows.
The request body must be a valid Ironclad workflow launch payload in JSON format, identical in structure to the synchronous create endpoint. Required fields are determined by the target workflow template's launch form schema.
The endpoint returns a job ID immediately. Use the Retrieve the Status of an Async Workflow Create Job source endpoint with this job ID to poll for the completion status and retrieve the resulting workflow ID once the job finishes.
Asynchronous workflow creation is recommended for bulk-creation scenarios or when integrating with systems that may generate workflows in large batches. Store the returned job ID in your data flow for subsequent status checks. Refer to the Ironclad Developer Hub for additional guidance.
Update Approval on a Workflow
Updates the approval status for a specific approver role on an Ironclad workflow. Use this endpoint to programmatically approve or reject a workflow approval step as part of an automated approval flow.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
Enter the unique identifier of the approver role to update in the Role ID field. This value is required. Role IDs can be retrieved from the List All Workflow Approvals source endpoint.
The request body (passed via the Nexset) should include the approval decision and any supporting information such as comments. Refer to the Ironclad Approvals API documentation for the expected request body format.
Send Signature Request
Sends a signature request for a workflow that is in the Sign step. Use this endpoint to programmatically initiate the signing process for a contract workflow.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required. The workflow must already be in the Sign step for this action to succeed.
The request body should include any required signer configuration or override parameters as defined in the Ironclad Signatures API. Refer to the Ironclad Workflows API documentation for the expected payload format.
Cancel Signature Request
Cancels a signature request that is currently out for signing. Use this endpoint when a signature request must be withdrawn — for example, if the contract needs to be revised before it can be signed.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required. The workflow must have an active signature request in progress for this action to succeed.
Generates a signing URL for a specific recipient to access and sign a workflow document. Use this endpoint when you need to distribute a direct signing link to a counterparty outside of Ironclad's built-in notification system.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The request body must include the signer's identity information to identify the correct recipient. Refer to the Ironclad Signatures API documentation for required fields.
The response will contain the generated signing URL, which can be distributed to the signer via email or another communication channel.
Create an Embeddable Recipient URL for a Signer
Generates an embeddable signing URL that enables a signer to complete their signature within an iframe embedded in your own application. Use this endpoint to build embedded signing experiences without redirecting the user to the Ironclad platform.
Enter the unique identifier of the workflow in the Workflow ID field. This value is required.
The request body must include the signer's identity information. Refer to the Ironclad Signatures API documentation for required fields and iframe integration guidance.
The response will contain an embeddable URL. This URL is intended for use in an iframe element within your application and should not be shared as a plain link.
Revert a Workflow to the Review Step
Reverts an Ironclad workflow from the Sign step back to the Review step. Use this endpoint when a contract that has been sent for signing needs to be recalled for further review and revisions.
The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly. The workflow must be in the Sign step for this action to succeed.
Cancels an active Ironclad workflow. Use this endpoint to programmatically cancel workflows that are no longer needed or were created in error.
The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly. Only active workflows (not already completed or cancelled) can be cancelled.
Pauses an active workflow that is currently in the Review step. Use this endpoint to temporarily halt workflow progress without cancelling it — for example, when a contract negotiation needs to be put on hold pending further information.
The Workflow ID must be included in the URL path. The workflow must be in the Review step for this action to succeed.
Adds a comment to a workflow's activity feed. Use this endpoint to programmatically post notes, status updates, or contextual information to the workflow's collaboration timeline.
The Workflow ID must be included in the URL path. Provide the workflow ID in the Nexset or configure the endpoint URL accordingly.
Updates specific metadata attributes on a workflow that is currently in the Review step. Use this endpoint to programmatically update contract attributes — such as counterparty details, contract value, or custom fields — without requiring manual edits in the Ironclad UI.
The Workflow ID must be included in the URL path. The workflow must be in the Review step for attribute updates to be accepted.
The request body should include only the attributes to be updated, using the attribute IDs defined in your Ironclad workflow template. Refer to the Workflow Attribute IDs reference in the Ironclad Developer Hub for guidance on constructing the payload.
Only attributes that correspond to editable fields in the workflow's Review step can be updated via this endpoint. Attempting to update attributes in a workflow that is in the Sign or Completed step will result in an error.
Create a Record
Creates a new contract record in the Ironclad Repository. Use this endpoint to programmatically add records for contracts that were negotiated and executed outside of Ironclad, enabling your organization to maintain a complete contract repository.
The request body must include the record's properties and record type. Required fields depend on the record type's schema in your Ironclad instance. Use the Retrieve Records Schema source endpoint to discover the available record types and their required fields before building this destination flow.
Optionally, include links to related workflows or other records, and any relationship data, as supported by the Ironclad Records API. Refer to the Create a Record guide in the Ironclad Developer Hub for complete payload documentation.
Records in Ironclad represent completed or externally executed contracts stored in the Repository. Creating records via the API is commonly used to import legacy contracts or contracts executed outside of Ironclad workflows.
Replace a Record
Replaces the complete data of an existing record by ID. Use this endpoint for a full update of a record's properties and relationships — this operation overwrites all existing field values.
Enter the unique identifier of the record to replace in the Record ID field. This value is required.
The request body must include the complete record payload with all required fields. Fields omitted from the payload will be cleared. Refer to the Ironclad Records API documentation for payload requirements.
:::warning Important
This is a full-replacement operation. Any fields not included in the request payload will be removed from the record. Use the "Update Record Metadata" endpoint if you only need to modify specific fields.
:::
Update Record Metadata
Partially updates specific fields on an existing Ironclad record. Use this endpoint when you need to update only certain attributes of a record without affecting other fields.
Enter the unique identifier of the record to update in the Record ID field. This value is required.
The request body should include only the fields to be updated. Fields not included in the payload will retain their current values. Refer to the Ironclad Records API documentation for supported fields and payload format.
Delete a Record
Permanently deletes an existing record from the Ironclad Repository by ID. Use this endpoint to remove records that were created in error or are no longer needed.
Enter the unique identifier of the record to delete in the Record ID field. This value is required.
:::danger Important
Record deletion is permanent and cannot be undone. Verify the Record ID before sending data to this endpoint, as there is no recovery option once the record is deleted.
:::
Ironclad destinations can also be manually configured to send data to any valid Ironclad API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Ironclad's public API base URL is your instance URL followed by /public/api/v1/ — for example, https://na1.ironcladapp.com/public/api/v1/workflows. SCIM-based user and group management endpoints use the SCIM base path instead: https://na1.ironcladapp.com/scim/v2/. For update or delete operations, include the ID of the object to be updated or deleted at the end of the URL path.
Most Ironclad API endpoints accept JSON (application/json); the create_record_attachment endpoint uses multipart/form-data for file uploads. You do not need to include an Authorization header — Ironclad's OAuth 2.0 Bearer token is automatically included by Nexla based on your credential configuration.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Ironclad endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Ironclad until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
