# Ironclad CLM API Documentation | Ironclad Developer Hub Documentation > Get comprehensive guides and documentation to help you start working with Ironclad’s API. Official Ironclad developer site. Append .md to any documentation page URL to get its markdown version. ## Guides - [Getting Started](https://developer.ironcladapp.com/docs/getting-started.md): Learn more about getting started with the Ironclad platform! - [Hello World of Contracts](https://developer.ironcladapp.com/docs/setting-up-and-collecting-signed-contracts.md): Covers the basics of Ironclad's API with a simple example of storing all signed contracts to a custom datastore. - [Launch a Workflow](https://developer.ironcladapp.com/docs/launch-a-workflow.md): This is a simple example outlining how to launch a workflow using our REST API. - [Field Types Supported for Workflows](https://developer.ironcladapp.com/docs/field-types-supported.md) - [Bulk Launch a Workflow](https://developer.ironcladapp.com/docs/bulk-launch-a-workflow.md): This is an example outlining how to bulk launch workflows using our REST API. - [Embed Acceptance via Ironclad Signature](https://developer.ironcladapp.com/docs/embed-acceptance-via-ironclad-signature.md): Embed the Ironclad Signature experience for a signer within an iframe. - [Analyze Contracts and Automate Decision-Making](https://developer.ironcladapp.com/docs/analyze-contracts-to-automating-decision-making.md): Seamlessly surface deal insights to contract requesters from internal systems or data sources. - [Sync Contract Review with a Procurement Process](https://developer.ironcladapp.com/docs/sync-contract-review-with-a-procurement-process.md): Link a contract workflow with a business process in another platform (in this case, JIRA). - [Overview](https://developer.ironcladapp.com/docs/byosp-overview.md): Route Ironclad signature requests through your own eSignature provider using a middleware service. - [Ironclad Setup](https://developer.ironcladapp.com/docs/byosp-ironclad-setup.md): Register your custom signature provider in Ironclad, create a client app, and configure transport security. - [Middleware Endpoints](https://developer.ironcladapp.com/docs/byosp-middleware-endpoints.md): The five HTTPS endpoints your middleware must implement for Ironclad to initiate, track, and complete a signature request. - [Request Signing](https://developer.ironcladapp.com/docs/byosp-request-signing.md): Verify the Ironclad request signature, check document integrity, and protect against replay on every outbound call. - [Status Updates](https://developer.ironcladapp.com/docs/byosp-status-updates.md): Push signature lifecycle events from your middleware back to Ironclad so the workflow can move forward. - [Create a Record](https://developer.ironcladapp.com/docs/create-a-record-1.md): Learn about creating an Ironclad Record via the API. - [Add Attachment to a Record](https://developer.ironcladapp.com/docs/add-attachment-to-a-record.md): Learn about adding an attachment to an Ironclad Record via the API. - [Using Repository Records & Google Sheets](https://developer.ironcladapp.com/docs/data-lakedata-warehouse-integration.md) - [Using the Smart Import API](https://developer.ironcladapp.com/docs/smart-import-guide.md) - [Smart Import API (Salesforce Example)](https://developer.ironcladapp.com/docs/smart-import-salesforce-example.md): Learn how to Smart Import a document from Salesforce to Ironclad using the Smart Import API. - [Record Amendments CRUD API Guide](https://developer.ironcladapp.com/docs/record-amendments-crud-api-guide.md): Learn how to create, read, update, and delete amendments using Ironclad's Records API. - [Entity References in Workflows and Records](https://developer.ironcladapp.com/docs/entity-references-in-workflows-records.md): Learn how to work with entity references in Ironclad workflows and records, including different approaches for handling entity data in API responses. - [Entities CRUD API Guide](https://developer.ironcladapp.com/docs/entities-crud-api-guide.md): Learn how to create, read, update, and delete entities using Ironclad's Entities API. - [Ironclad Repository to Entities Migration Guide](https://developer.ironcladapp.com/docs/ironclad-repository-to-entities-migration-guide.md) - [Entities Integration Guide](https://developer.ironcladapp.com/docs/entities-integration-guide.md) - [ServiceNow Integration](https://developer.ironcladapp.com/docs/servicenow-guide.md) - [Setting Up the Ironclad Power Automate Connector](https://developer.ironcladapp.com/docs/setting-up-the-ironclad-power-automate-connector.md) - [Dynamics 365 Integration (via Tray.io)](https://developer.ironcladapp.com/docs/guide-dynamics-trayio.md) - [Overview](https://developer.ironcladapp.com/docs/overview.md) - [Prerequisites](https://developer.ironcladapp.com/docs/prerequisites.md) - [Upload Power Automate Connector](https://developer.ironcladapp.com/docs/copy-of-setting-up-the-ironclad-power-automate-connector.md) - [Dynamics 365 Setup](https://developer.ironcladapp.com/docs/dynamics-365-setup.md) - [Ironclad Setup](https://developer.ironcladapp.com/docs/ironclad-setup.md) - [Launching Ironclad Workflows Directly from Dynamics 365](https://developer.ironcladapp.com/docs/launching-ironclad-workflows-directly-from-dynamics-365.md) - [Update Contract Status from Ironclad to Dynamics 365](https://developer.ironcladapp.com/docs/update-contract-status-from-ironclad-to-dynamics-365.md) - [Managing Approval Processes from Dynamics 365 to Ironclad](https://developer.ironcladapp.com/docs/managing-approval-processes-from-dynamics-365-to-ironclad.md) - [Document Upload: Ironclad to Dynamics 365](https://developer.ironcladapp.com/docs/document-upload-ironclad-to-dynamics-365.md) - [Summary](https://developer.ironcladapp.com/docs/summary.md) - [Hubspot Integration (via Tray.io)](https://developer.ironcladapp.com/docs/hubspot-integration-trayio.md) - [NetSuite Integration (via Tray.io)](https://developer.ironcladapp.com/docs/netsuite-integration-trayio.md) - [Jira Software Cloud (Zapier)](https://developer.ironcladapp.com/docs/jira-integration-with-zapier.md) - [Launch Ironclad Workflow from Jira](https://developer.ironcladapp.com/docs/launch-ironclad-workflow-from-jira.md) - [Sync Jira Data to Ironclad](https://developer.ironcladapp.com/docs/sync-jira-data-to-ironclad.md) - [Update Jira after Ironclad Approval](https://developer.ironcladapp.com/docs/update-jira-after-ironclad-approval.md) - [Update Jira after Ironclad Workflow Completed](https://developer.ironcladapp.com/docs/update-jira-after-ironclad-workflow-completed.md) - [Jira Software Cloud (Jira Automation)](https://developer.ironcladapp.com/docs/jira-software-cloud-jira-automation.md) - [Launch Ironclad Workflow from Jira (Automation Rule)](https://developer.ironcladapp.com/docs/launch-ironclad-workflow-from-jira-automation-rule.md) - [Sync Jira Data to Ironclad (Automation Rule)](https://developer.ironcladapp.com/docs/sync-jira-data-to-ironclad-automation-rule.md) - [Update Jira after Ironclad Approval (Automation Rule)](https://developer.ironcladapp.com/docs/update-jira-after-ironclad-approval-automation-rule.md) - [Reporting via Data Warehouse Integration](https://developer.ironcladapp.com/docs/reporting-via-data-warehouse-integration.md) - [Reporting via Event-driven Data Warehouse Integration](https://developer.ironcladapp.com/docs/reporting-via-event-driven-data-warehouse-integration.md) - [Box Integration with Smart Import](https://developer.ironcladapp.com/docs/box-smart-import-guide.md) - [Introduction to the Security & Data Pro Add-on](https://developer.ironcladapp.com/docs/security-data-add-on.md): An overview of the Security & Data Pro Add-on - [Security Overview](https://developer.ironcladapp.com/docs/security-overview.md): Security & Data Pro: Security Overview - [Getting Started with Per-Tenant Encryption](https://developer.ironcladapp.com/docs/per-tenant-encryption-getting-started.md): Setting up per-tenant encryption - [Per-Tenant Encryption Features](https://developer.ironcladapp.com/docs/per-tenant-encryption-features.md): Learn about the features of per-tenant encryption - [Setup Standard Encryption](https://developer.ironcladapp.com/docs/setup-antimatter.md) - [Setup HYOK for GCP](https://developer.ironcladapp.com/docs/setup-hyok-gcp.md) - [Per-Tenant Encryption FAQs](https://developer.ironcladapp.com/docs/per-tenant-encryption-faqs.md): Get answers to frequently asked questions - [Data Overview](https://developer.ironcladapp.com/docs/data-overview.md): Security & Data Pro: Data Overview - [Getting Started with Data Exports](https://developer.ironcladapp.com/docs/data-exports-getting-started.md): Understand how Data Exports works - [Data Exports Features](https://developer.ironcladapp.com/docs/data-exports-features.md): Learn about the features of data exports - [Explore the contents of Data Exports](https://developer.ironcladapp.com/docs/data-exports-details.md): What should you expect to see in data exports? - [Data Exports FAQs](https://developer.ironcladapp.com/docs/data-exports-faqs.md): Get answers to frequently asked questions - [MuleSoft Connector](https://developer.ironcladapp.com/docs/mulesoft-connector.md) - [Embed a Clickwrap](https://developer.ironcladapp.com/docs/embed-a-clickwrap.md): This is a simple example outlining how to embed a clickwrap within an iframe. ## API Reference - [Getting Started](https://developer.ironcladapp.com/reference/getting-started-api.md) - [Authentication](https://developer.ironcladapp.com/reference/authentication-api.md) - [Register an OAuth Client](https://developer.ironcladapp.com/reference/register-oauth-client.md) - [Authorization Code Grant](https://developer.ironcladapp.com/reference/authorization-code-grant.md) - [Client Credentials Grant](https://developer.ironcladapp.com/reference/client-credentials-grant.md) - [Authenticate a Request](https://developer.ironcladapp.com/reference/authenticate-a-request.md) - [Design Considerations](https://developer.ironcladapp.com/reference/auth-design-considerations.md) - [Legacy Access Token](https://developer.ironcladapp.com/reference/legacy-access-token.md) - [Migrating to OAuth 2.0](https://developer.ironcladapp.com/reference/guidance-for-oauth-migration.md) - [OAuth 2.0 FAQs](https://developer.ironcladapp.com/reference/oauth-20-faqs.md) - [Filter Query Parameter](https://developer.ironcladapp.com/reference/filter-query-param.md): Learn about how to use filter formulas when searching objects in the Ironclad Public API - [Request IDs](https://developer.ironcladapp.com/reference/requests-ids.md) - [Rate Limits](https://developer.ironcladapp.com/reference/clm-api-rate-limits.md): Learn about API rate limits and how to work with them. - [Create a Workflow Synchronously](https://developer.ironcladapp.com/reference/launch-a-new-workflow.md): Launch a new Workflow synchronously. **OAuth Scope required:** `public.workflows.createWorkflows` - [List All Workflows](https://developer.ironcladapp.com/reference/list-all-workflows.md): List all workflows in your Ironclad account. **OAuth Scope required:** `public.workflows.readWorkflows` - [Create a Workflow Asynchronously](https://developer.ironcladapp.com/reference/create-a-new-workflow-async.md): Launch a new Workflow asynchronously for non-blocking performance, which is helpful when/if you provide files to the Workflow. **OAuth Scope required:** `public.workflows.createWorkflows` - [Retrieve the Status of an Async Workflow Create Job](https://developer.ironcladapp.com/reference/retrieve-asynchronous-workflow-status.md): Check the status of a Workflow you created while using the [Create a Workflow Async](https://developer.ironcladapp.com/reference/create-a-workflow-sync-vs-async#create-a-new-workflow-async) route. **OAuth Scope required:** `public.workflows.createWorkflows` - [Retrieve a Workflow](https://developer.ironcladapp.com/reference/retrieve-a-workflow.md): View the data associated with a specific workflow. **OAuth Scope required:** `public.workflows.readWorkflows` - [List All Workflow Approvals](https://developer.ironcladapp.com/reference/list-all-workflow-approvals.md): Returns a list of approvals for the workflow. The `approvalGroups` property will display only triggered approvals (i.e. conditional approvals that have not been triggered will not appear). **OAuth Scope required:** `public.workflows.readApprovals` - [Retrieve the Approval Requests on a Workflow](https://developer.ironcladapp.com/reference/approval-requests.md): Returns a list of approval requests that have taken place on the workflow. **OAuth Scope required:** `public.workflows.readApprovals` - [Update Approval Status on a Workflow](https://developer.ironcladapp.com/reference/update-workflow-approval.md): Updates the status of an approval to the specified value. Approval statuses can only be updated during the Review step and when a given approval group is active (when it is that group's turn to approve). **OAuth Scope required:** `public.workflows.updateApprovals` - [Retrieve the Turn History on a Workflow](https://developer.ironcladapp.com/reference/turn-history.md): An array of objects for each turn on a workflow. **OAuth Scope required:** `public.workflows.readTurnHistory` - [Retrieve Sign Step Status](https://developer.ironcladapp.com/reference/get-sign-status.md): Returns information about a workflow in the sign step. **OAuth Scope required:** `public.workflows.readSignStatus` **NOTE:** The workflow must be in the sign step to access this route. - [Send Signature Request](https://developer.ironcladapp.com/reference/send-signature-request.md): Send a signature request. **OAuth Scope required:** `public.workflows.sendSignatureRequests` **Note**: You can only send a packet out for signature if all signers have an associated signature or initials tag (tag requirements are dependent on the signature provider). - [Cancel Signature Request](https://developer.ironcladapp.com/reference/cancel-signature-request.md): Cancel a signature request that was out for signature. **OAuth Scope required:** `public.workflows.cancelSignatureRequests` - [Update Signer](https://developer.ironcladapp.com/reference/update-signer.md): Reassign a signer or edit an external signer's name or email, as specified by the `signerRoleName` parameter. The original signer will receive an email that the packet has been reassigned if it was sent out for signature. **OAuth Scope required:** `public.workflows.updateSigners` **NOTE**: Editing a signer will not cancel a signature request unless your configured signature provider is Adobe Sign. Also, you cannot update a signer that has already signed via the API for any signature provider. - [Delete Signer](https://developer.ironcladapp.com/reference/delete-signer.md): Deletes a signer from a signature packet, as specified by the `signerRoleName` parameter. **OAuth Scope required:** `public.workflows.deleteSigners` **NOTE**: Removing a signer will cancel the current packet that is out collecting signatures. - [Remind Signer](https://developer.ironcladapp.com/reference/remind-signer.md): Send a reminder email to a signer that a signature is needed. **OAuth Scope required:** `public.workflows.remindSigners` **NOTE**: You can only send a reminder after the signature packet has been sent out for signature. Also, if using Adobe Sign as your signature provider, reminding a signer reminds all unsigned signers. - [List All Workflow Signers](https://developer.ironcladapp.com/reference/list-all-workflow-signers.md): Returns a list of workflow signers and the status of their signature. **OAuth Scope required:** `public.workflows.readSignatures` - [Create a Recipient URL for a Signer](https://developer.ironcladapp.com/reference/create-recipient-url.md): Create a recipient URL for a signer or viewer to access the signature request. This functionality is exclusive to Ironclad Signature. See [this help center article](https://support.ironcladapp.com/hc/en-us/articles/12276957992983-Manage-Signatures-During-the-Sign-Step#copysignerlink) for more information. **OAuth Scope required:** `public.workflows.createSignatureRecipientUrls` - [Create an Embeddable Recipient URL for a Signer](https://developer.ironcladapp.com/reference/create-embeddable-recipient-url.md): Create an embeddable recipient URL for a signer to access the signature request. This functionality is exclusive to Ironclad Signature. See [this help center article](https://support.ironcladapp.com/hc/en-us/articles/12276957992983-Manage-Signatures-During-the-Sign-Step#copysignerlink) for more information. **OAuth Scope required:** `public.workflows.createEmbeddableSignerUrls` - [Create a Signed Document on a Workflow](https://developer.ironcladapp.com/reference/workflow-upload-signed-document.md): Upload a fully or partially signed document to a specified workflow that is in sign step. **OAuth Scope required:** `public.workflows.uploadSignedDocuments` - [List All Workflow Participants](https://developer.ironcladapp.com/reference/list-all-workflow-participants.md): Returns a list of workflow participants. **OAuth Scope required:** `public.workflows.readParticipants` - [Revert a Workflow to the Review Step](https://developer.ironcladapp.com/reference/revert-to-review.md): Reverts a workflow to the Review step. Only workflows sourced from Workflow Designer and in the Sign step can be reverted. **OAuth Scope required:** `public.workflows.revertToReview` - [Cancel a Workflow](https://developer.ironcladapp.com/reference/cancel-a-workflow.md): Cancel a workflow. **OAuth Scope required:** `public.workflows.cancel` - [Pause a Workflow](https://developer.ironcladapp.com/reference/pause-a-workflow.md): Pause an active workflow. **OAuth Scope required:** `public.workflows.pauseAndResume` - [Resume a Workflow](https://developer.ironcladapp.com/reference/resume-a-workflow.md): Resume a paused Workflow. **OAuth Scope required:** `public.workflows.pauseAndResume` - [Create a Comment on a Workflow](https://developer.ironcladapp.com/reference/deprecated-create-a-comment-on-a-workflow.md): Creates a comment in the specified workflow's activity feed. - [Create a Comment on a Workflow](https://developer.ironcladapp.com/reference/create-a-comment-on-a-workflow.md): Creates a comment in the specified workflow's activity feed. **OAuth Scope required:** `public.workflows.createComments` - [List all Comments on a Workflow](https://developer.ironcladapp.com/reference/list-all-comments-in-a-workflow.md): Return a list of comments on a workflow. **OAuth Scope required:** `public.workflows.readComments` - [List a Comment from a Specified Workflow](https://developer.ironcladapp.com/reference/list-a-comment-from-a-workflow.md): Return a single comment for a specified workflow. **OAuth Scope required:** `public.workflows.readComments` - [Update Workflow Metadata](https://developer.ironcladapp.com/reference/update-workflow-metadata.md): The workflow must be in the Review step in order for its data to be updated. Use the `remove` action to clear field values and the `set` action to add or modify values. Form validation is enforced; required fields cannot be removed and any required fields triggered by conditions must be populated. **Note:** This endpoint does not support updating document/file type attributes. To manage documents, use the [Create a Document on a Workflow](https://developer.ironcladapp.com/reference/create-a-workflow-document) and [Update Signature Packet on a Workflow](https://developer.ironcladapp.com/reference/update-workflow-signature-packet) endpoints. **OAuth Scope required:** `public.workflows.updateWorkflows` - [Create a Document on a Workflow](https://developer.ironcladapp.com/reference/create-a-workflow-document.md): Create a document in the specified workflow attribute. If a document key to an existing draft document is provided, the new file will be uploaded as a new version of the existing document. For all other non-draft documents and when document key is absent, this operation will only append the new document to the document attribute array. Please note that to upload a signed document, reference the [Create a Signed Document on a Workflow](https://developer.ironcladapp.com/reference/workflow-upload-signed-document) endpoint. **OAuth Scope required:** `public.workflows.createDocuments` - [Retrieve a Workflow Document](https://developer.ironcladapp.com/reference/retrieve-a-workflow-document.md): Download a document associated with a specific workflow via a reference to its document key. **OAuth Scope required:** `public.workflows.readDocuments` - [Retrieve Email Threads from A Workflow](https://developer.ironcladapp.com/reference/retrieve-email-threads-from-workflow.md): List all email threads in the specified workflow. **OAuth Scope required:** `public.workflows.readEmailCommunications` - [Retrieve an Email Thread from a Specified Workflow](https://developer.ironcladapp.com/reference/retrieve-email-thread-from-workflow.md): List a single email thread for a specified workflow. **OAuth Scope required:** `public.workflows.readEmailCommunications` - [Retrieve an Attachment from an Email Thread](https://developer.ironcladapp.com/reference/retrieve-attachment-from-email-thread.md): Retrieve an attachment from the specified email thread. **OAuth Scope required:** `public.workflows.readEmailCommunications` - [List All Workflow Schemas](https://developer.ironcladapp.com/reference/list-all-workflow-schemas.md): Returns a list of workflow schemas. Each schema specifies the fields used in the workflow's launch form. **OAuth Scope required:** `public.workflows.readSchemas` - [Retrieve a Workflow Schema](https://developer.ironcladapp.com/reference/retrieve-a-workflow-schema.md): Returns the fields used in the workflow's launch form. **OAuth Scope required:** `public.workflows.readSchemas` - [Retrieve Documents from a Workflow](https://developer.ironcladapp.com/reference/retrieve-workflow-documents.md): Retrieve all documents from a workflow that are included and excluded from the signature packet. **OAuth Scope required:** `public.workflows.readDocuments` - [Update Signature Packet on a Workflow](https://developer.ironcladapp.com/reference/update-workflow-signature-packet.md): Update a workflow's signature packet by moving documents into it, moving documents out of it, or reordering documents within it. The request body specifies which workflow documents should be in the signature packet and their order. Documents in the request but not currently in the signature packet will be moved into it. Documents currently in the signature packet but not in the request will be moved out of it. **Note:** Only editable file types (.doc, .docx, .pdf) can be included in the signature packet. **Restrictions:** - Workflow must be at Review stage - All document keys must be valid editable documents on the workflow **OAuth Scope required:** `public.workflows.updateSignaturePacket` - [Schedule Send Signature Request](https://developer.ironcladapp.com/reference/schedule-send-signature-request.md): Schedule a signature request to be sent out for signature. The workflow must be on the Sign step and not yet out for signature. **OAuth Scope required:** `public.workflows.scheduleSendSignatureRequest` - [Update Scheduled Signature Request](https://developer.ironcladapp.com/reference/update-scheduled-signature-request.md): Update a scheduled signature request. The workflow must be on the Sign step and not yet out for signature. **OAuth Scope required:** `public.workflows.updateScheduledSignatureRequest` - [Delete Scheduled Signature Request](https://developer.ironcladapp.com/reference/delete-scheduled-signature-request.md): Delete a scheduled signature request. The workflow must be on the Sign step and not yet out for signature. **OAuth Scope required:** `public.workflows.deleteScheduledSignatureRequest` - [Update Workflow Role Assignment](https://developer.ironcladapp.com/reference/update-workflow-role-assignment.md): Updates the assignment of the specified role (e.g. Archiver, Signature Coordinator, etc.) on the workflow to a new user. The new assignee must be eligible to be assigned to the role per the workflow definition configured in workflow designer. Note: If a role is assigned to another role in the workflow configuration, the new assignee will be assigned to both roles. **OAuth Scope required:** `public.workflows.updateRoleAssignment` - [List Eligible Assignees for a Workflow Role](https://developer.ironcladapp.com/reference/list-workflow-role-eligible-assignees.md): Returns a paginated list of users eligible to be assigned to the specified role on the workflow along with the user ID of current assignee if a user is already assigned to the role. **OAuth Scope required:** `public.workflows.readRoleAssignees` - [Launch a Workflow from an Attribute Source](https://developer.ironcladapp.com/reference/launch-workflow-from-attribute-source.md): Launches a workflow from a source object using a pre-existing workflow sync mapping. Currently only supports Coupa and Salesforce. **OAuth Scope required:** `public.workflows.createFromSource` - [Refresh a Workflow from an Attribute Source](https://developer.ironcladapp.com/reference/refresh-workflow-from-attribute-source.md): Refreshes a workflow from an attribute source configuration, such as a Coupa or Salesforce workflow sync mapping. **OAuth Scope required:** `public.workflows.updateFromSource` - [Update Custom Signature Request Status (BYOSP)](https://developer.ironcladapp.com/reference/update-custom-signature-request-status.md): Inbound webhook endpoint for Bring Your Own Signature Provider (BYOSP) middleware. The customer-built middleware posts signature lifecycle events here so Ironclad can update the corresponding signature request and fire workflow events. **OAuth Scope required:** `public.signatureRequests.updateRequest` Returns `204 No Content` on success. Idempotent — once an envelope has reached `completed` or `voided`, subsequent pushes are no-ops. - [List All Records](https://developer.ironcladapp.com/reference/list-all-records.md): View all records in the company, with filtering available via query parameters. **OAuth Scope required:** `public.records.readRecords` - [Create a Record](https://developer.ironcladapp.com/reference/create-a-record.md): Create a contract record by specifying its intended metadata properties. See [more documentation](https://developer.ironcladapp.com/docs/create-a-record-1) on creating a record. **OAuth Scope required:** `public.records.createRecords` - [Retrieve Predictions](https://developer.ironcladapp.com/reference/retrieve-import-predictions.md): Retrieve status of predictions of specific smart import record or all records in an import, one of Record Id or Import Id is required. **OAuth Scope required:** `public.records.readSmartImportRecords` - [Create a Smart Import Record](https://developer.ironcladapp.com/reference/create-a-smart-import-record.md): Upload a file to create a record with smart import and predictions. Provide none of recordType, newRecordTypeId, or newRecordTypeDisplayName to default to Imported type. **OAuth Scope required:** `public.records.createSmartImportRecords` - [Upload a Smart Import Record to an existing Import](https://developer.ironcladapp.com/reference/create-a-smart-import-record-to-import.md): Upload a file to an existing import and create a record with smart import and predictions. Provide none of recordType, newRecordTypeId, or newRecordTypeDisplayName to default to Imported type. **OAuth Scope required:** `public.records.createSmartImportRecords` - [Retrieve a Record](https://developer.ironcladapp.com/reference/retrieve-a-record.md): View a specific record and its associated data. **OAuth Scope required:** `public.records.readRecords` - [Replace a Record](https://developer.ironcladapp.com/reference/replace-a-record.md): Update an existing record with a new set of metadata. **OAuth Scope required:** `public.records.updateRecords` - [Delete a Record](https://developer.ironcladapp.com/reference/delete-a-record.md): Delete an existing record. **OAuth Scope required:** `public.records.deleteRecords` - [Update Record Metadata](https://developer.ironcladapp.com/reference/update-record-metadata.md): Update specific fields on a record. **OAuth Scope required:** `public.records.updateRecords` - [Retrieve Records Schema](https://developer.ironcladapp.com/reference/list-all-records-metadata.md): View the schema associated with contract records, including available record types and metadata properties. **OAuth Scope required:** `public.records.readSchemas` - [Create an Attachment on a Record](https://developer.ironcladapp.com/reference/create-an-attachment-on-a-record.md): Create an attachment on a specified record at the specified attachment key. **OAuth Scope required:** `public.records.createAttachments` - [Retrieve an Attachment on a Record](https://developer.ironcladapp.com/reference/retrieve-an-attachment-on-a-record.md): View an attachment associated with a specific record. **OAuth Scope required:** `public.records.readAttachments` - [Delete an Attachment on a Record](https://developer.ironcladapp.com/reference/delete-an-attachment-on-a-record.md): Remove an attachment associated with a specific record. **OAuth Scope required:** `public.records.deleteAttachments` - [Run an Action on a Record](https://developer.ironcladapp.com/reference/run-an-action-on-a-record.md): Runs an action on the contract. It supports lifecycle actions such as activating a contract. **OAuth Scope required:** `public.records.applyContractAction` - [Retrieve XLSX Export File of Records](https://developer.ironcladapp.com/reference/retrieve-xlsx-export-file-of-all-records.md): Export a records report with filtering available via query parameters. **OAuth Scope required:** `public.records.readRecords` - [Get All Entity Relationship Types](https://developer.ironcladapp.com/reference/get-all-entity-relationship-types.md): Returns all entity relationship types. For more information, see [Entity Relationship Types](https://support.ironcladapp.com/hc/en-us/articles/28005038398231-Create-Manage-Relationship-Types-and-Entity-Properties). **OAuth Scope required:** `public.entities.readRelationshipTypes` - [List All Entities](https://developer.ironcladapp.com/reference/list-all-entities.md): View all entities in the company, with filtering available via query parameters. **OAuth Scope required:** `public.entities.readEntities` - [Create an Entity](https://developer.ironcladapp.com/reference/create-an-entity.md): Create a new entity. More details on creating an entity can be found in the [Entity Overview](https://support.ironcladapp.com/hc/en-us/articles/28004816859543-Create-and-Manage-Entities) article. **OAuth Scope required:** `public.entities.createEntities` - [Retrieve an Entity](https://developer.ironcladapp.com/reference/retrieve-an-entity.md): View a specific entity and its associated data. **OAuth Scope required:** `public.entities.readEntities` - [Update an Entity](https://developer.ironcladapp.com/reference/update-an-entity.md): Update an entity's name, relationship type, and properties. More details on managing an entity can be found in the [Entity Overview](https://support.ironcladapp.com/hc/en-us/articles/28004816859543-Create-and-Manage-Entities) article. **OAuth Scope required:** `public.entities.updateEntities` - [Delete an Entity](https://developer.ironcladapp.com/reference/delete-an-entity.md): Delete an existing entity. **OAuth Scope required:** `public.entities.deleteEntities` - [List All Obligations](https://developer.ironcladapp.com/reference/list-all-obligations.md): View all obligations in the company, with filtering available via query parameters. Responses include both source obligations and their instances (occurrences); use the `obligationType` field to tell them apart (`SOURCE` vs `OCCURRENCE`). **OAuth Scope required:** `public.obligations.readObligations` - [Create an Obligation](https://developer.ironcladapp.com/reference/create-an-obligation.md): Create an obligation. This endpoint has two modes. **Standalone obligation** — omit `sourceObligationId`. Creates an obligation on the contract given by `parentId`. Do not send `status`, `dueDate`, `assigneeUserId`, or `description`; those apply only to instances (see below). **Triggered instance** — set `sourceObligationId` to an existing source obligation that is configured for triggered occurrences. This records a new occurrence of that obligation (for example, when its triggering condition is met). In this mode `status`, `dueDate`, and `assigneeUserId` are required; `description` is optional; `parentId` is optional and, if sent, must match the source obligation's contract; and `obligationTypeKey` may be omitted (it is inherited from the source obligation, and must match it if sent). Creating instances requires triggered obligations to be enabled for your account. An obligation's recurrence `cadence` is configured in the Ironclad app and cannot be set through this API. Instances created here are always `TRIGGERED` occurrences; recurring occurrences are generated automatically by Ironclad. See the `ObligationModel` schema for the full source/occurrence model. **OAuth Scope required:** `public.obligations.createObligations` - [Retrieve an Obligation](https://developer.ironcladapp.com/reference/retrieve-an-obligation.md): View a specific obligation and its associated data. The response distinguishes a source obligation from an instance (occurrence) via the `obligationType` field; see the `ObligationModel` schema. **OAuth Scope required:** `public.obligations.readObligations` - [Update an Obligation](https://developer.ironcladapp.com/reference/update-an-obligation.md): Update an existing obligation. The path `id` identifies the obligation to update. `name`, `obligationTypeKey`, `addProperties`, and `removeProperties` can be updated on any obligation. `status`, `dueDate`, `assigneeUserId`, and `description` can be changed only on **instances** (occurrences of a source obligation) and are rejected on source obligations; to edit an instance, include its `sourceObligationId` in the body so the path `id` is treated as an instance. `dueDate` cannot be changed on recurring instances. At least one updatable field must be supplied. **OAuth Scope required:** `public.obligations.updateObligations` - [Get All Obligation Types](https://developer.ironcladapp.com/reference/get-all-obligation-types.md): Returns all obligation types. For more information, see [Obligation Types](https://support.ironcladapp.com/hc/en-us/articles/41818015138839-Obligation-Types). **OAuth Scope required:** `public.obligations.readTypes` - [Delete an Obligation](https://developer.ironcladapp.com/reference/delete-an-obligation.md): Delete an obligation. Accepts the ID or Ironclad ID of an obligation. Triggered instances are deleted directly. A recurring instance cannot be deleted on its own — it would be regenerated — so the API returns `409` with the parent obligation's ID in `sourceObligationId`; delete the parent source obligation to remove it. **OAuth Scope required:** `public.obligations.deleteObligations` - [Webhooks](https://developer.ironcladapp.com/reference/webhooks.md): Get notified in real time of events happening in your account - [Webhook Verification](https://developer.ironcladapp.com/reference/webhook-verification.md) - [Webhook Authentication](https://developer.ironcladapp.com/reference/webhook-authentication.md) - [Webhook Deactivation](https://developer.ironcladapp.com/reference/webhook-deactivation.md): Understand how Ironclad automatically disables consistently failing webhooks to protect your integrations - [Create a Webhook](https://developer.ironcladapp.com/reference/create-a-webhook.md): Creates a webhook for the specified events. Send separate requests if you need to create webhooks for multiple target URLs. Each target URL may only have one active registration. **OAuth Scope required:** `public.webhooks.createWebhooks` - [List All Webhooks](https://developer.ironcladapp.com/reference/list-all-webhooks.md): View all webhooks associated with a specific company with filtering available via query parameters. **OAuth Scope required:** `public.webhooks.readWebhooks` - [Retrieve a Webhook](https://developer.ironcladapp.com/reference/retrieve-a-webhook.md): View the data associated with a specific webhook. **OAuth Scope required:** `public.webhooks.readWebhooks` - [Update a Webhook](https://developer.ironcladapp.com/reference/update-a-webhook.md): Update the data associated with a specific webhook. **OAuth Scope required:** `public.webhooks.updateWebhooks` - [Delete a Webhook](https://developer.ironcladapp.com/reference/delete-a-webhook.md): Delete a specific webhook. **OAuth Scope required:** `public.webhooks.deleteWebhooks` - [Retrieve Webhook Verification Key](https://developer.ironcladapp.com/reference/retrieve-webhook-verification-key.md): View the verification key for webhook security implementations - [Submit a request to generate a new data export](https://developer.ironcladapp.com/reference/export.md): Submit a request to generate a new data export. **OAuth Scope required:** `public.export.createReports` The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package. - [Check Data Export Job Status](https://developer.ironcladapp.com/reference/export-job.md): View the status of an export job using the job id returned during job creation. **OAuth Scope required:** `public.export.readReports` The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package. - [Download Data Export File](https://developer.ironcladapp.com/reference/export-job-download.md): Download completed file produced by the export job. **OAuth Scope required:** `public.export.readReports` The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package. - [List all Users](https://developer.ironcladapp.com/reference/retrieve-all-users.md): Documentation on listing Users via SCIM. **OAuth Scope required:** `scim.users.readUsers` - [Create a User](https://developer.ironcladapp.com/reference/create-a-user.md): Documentation on creating a User via SCIM. **OAuth Scope required:** `scim.users.createUsers` - [Retrieve a User](https://developer.ironcladapp.com/reference/retrieve-a-user.md): Documentation on accessing User info via SCIM. **OAuth Scope required:** `scim.users.readUsers` - [Update User Data](https://developer.ironcladapp.com/reference/update-user-data.md): Documentation on updating a User via SCIM. **OAuth Scope required:** `scim.users.updateUsers` - [Replace a User](https://developer.ironcladapp.com/reference/replace-a-user.md): Documentation on replacing a User via SCIM. **OAuth Scope required:** `scim.users.updateUsers` - [Delete a User](https://developer.ironcladapp.com/reference/delete-a-user.md): Delete a user on Ironclad. If the deletion is successful, all active workflows associated with the deleted user should be automatically reassigned to the default user within the admin group. To learn how to set a default user, see the [Manage Groups](https://support.ironcladapp.com/hc/en-us/articles/12286570480791-Manage-Groups) guide. If the company has enabled the setting that prevents deleting non-deactivated users, the user must be deactivated (via `active: false`) before they can be deleted. **OAuth Scope required:** `scim.users.deleteUsers` - [List all Groups](https://developer.ironcladapp.com/reference/retrieve-all-groups.md): Documentation on listing Groups via SCIM. **OAuth Scope required:** `scim.groups.readGroups` - [Create a Group](https://developer.ironcladapp.com/reference/create-a-group.md): Documentation on creating a Group via SCIM. **OAuth Scope required:** `scim.groups.createGroups` - [Retrieve a Group](https://developer.ironcladapp.com/reference/retrieve-a-group.md): Documentation on accessing a Group via SCIM. **OAuth Scope required:** `scim.groups.readGroups` - [Update a Group](https://developer.ironcladapp.com/reference/update-group-membership.md): Documentation on updating a Group via SCIM. This includes updating group membership. **OAuth Scope required:** `scim.groups.updateGroups` - [Replace a Group](https://developer.ironcladapp.com/reference/replace-a-group.md): Documentation on replacing a Group via SCIM. **OAuth Scope required:** `scim.groups.updateGroups` - [Delete a Group](https://developer.ironcladapp.com/reference/delete-a-group.md): **Deprecated:** Group deletion via SCIM is disabled. This action must be performed via the Admin Group page. **OAuth Scope required:** `scim.groups.deleteGroups` - [List all Schemas](https://developer.ironcladapp.com/reference/list-all-schemas.md): Documentation on listing all Schemas via SCIM. **OAuth Scope required:** `scim.schemas.readSchemas` - [Retrieve a Schema](https://developer.ironcladapp.com/reference/retrieve-a-schema.md): Documentation on retrieving a schema via SCIM. **OAuth Scope required:** `scim.schemas.readSchemas` - [Initiate an Authorization Transaction](https://developer.ironcladapp.com/reference/oauth-authorize-1.md): This endpoint is used to request authorization from a user to access their Ironclad data on their behalf. This is the initial request of an Authorization Code grant flow. The client application generally initiates the authorization flow, where a user will be redirected to Ironclad to log in and grant the requested permissions. The user is then redirected back to the client application redirect URI with an authorization code. See endpoint [specification](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1). - [Request a Token](https://developer.ironcladapp.com/reference/oauth-token-1.md): This endpoint is used to request a token from the authorization server. If requesting an initial token in the Authorization Code grant, an authorization code, client ID, and client secret must be provided. If requesting to refresh an existing token in the Authorization Code grant, a refresh token, client ID, and client secret must be provided. If requesting a token via the Client Credentials grant, a client ID and secret must be provided. See endpoint [specification](https://datatracker.ietf.org/doc/html/rfc6749#section-3.2). - [Retrieve Token User Info](https://developer.ironcladapp.com/reference/oauth-userinfo-1.md): After a client application has obtained an access token, it can make a request to the /userinfo endpoint to get user-related information. The data returned include the user's ID, email, username, and other profile details along with the scopes granted to the token. ## Recipes - [Create a Record](https://developer.ironcladapp.com/recipes/create-a-record.md) - [Launch a Workflow](https://developer.ironcladapp.com/recipes/launch-a-workflow.md) - [Retrieve Draft Workflow Documents](https://developer.ironcladapp.com/recipes/retrieve-draft-workflow-documents.md) - [Retrieve Workflow Signed PDF](https://developer.ironcladapp.com/recipes/retrieve-workflow-signed-pdf.md) ## Changelog - [Release Notes](https://developer.ironcladapp.com/changelog/release-notes.md)