Ironclad Records API
Documentation on Ironclad Records.
Ironclad Records 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 Records. 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 17 operations across 10 paths, and defines 55 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.
17 operations
10 paths
55 schemas
2 DELETE7 GET1 PATCH6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 17
Across 10 paths, the API surfaces 17 operations — 2 DELETE, 7 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Records 17
Documentation on Ironclad Records.
GET
/records
List All Records
POST
/records
Create a Record
POST
/records/attachments/download-urls
Create Attachment Download URLs
GET
/records/attachments/download-urls/{jobId}
Get Attachment Download URLs Status
GET
/records/smart-import
Retrieve Predictions
POST
/records/smart-import
Create a Smart Import Record
POST
/records/smart-import/{importId}
Upload a Smart Import Record to an existing Import
GET
/records/{id}
Retrieve a Record
PUT
/records/{id}
Replace a Record
DELETE
/records/{id}
Delete a Record
PATCH
/records/{id}
Update Record Metadata
GET
/records/metadata
Retrieve Records Schema
POST
/records/{id}/attachments/{key}
Create an Attachment on a Record
GET
/records/{id}/attachments/{key}
Retrieve an Attachment on a Record
DELETE
/records/{id}/attachments/{key}
Delete an Attachment on a Record
POST
/records/{id}/actions
Run an Action on a Record
GET
/records/export
Retrieve XLSX Export File of Records
Schemas 55
The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are RecordModel (14 properties), ClauseLanguagePositionPlaybook (3 properties), RecordPropertyMonetaryAmount (3 properties), RecordPropertyEmail (3 properties). Each schema is shown below with its type and property counts.
ClauseLanguagePositionPlaybook
object
A playbook clause language position
3 properties
3 required
BadRequestErrorRecordNotFound
object
Bad request error. The specified record does not exist.
2 properties
RecordPropertyArray
object
An array-type record property
2 properties
2 required
SourcedFromIntegration
object
Record created from an integration
2 properties
2 required
RecordPropertyPlaybookClause
object
A playbook-based clause-type record property
2 properties
2 required
EffectiveContractActionProperties
object
2 properties
BadRequestErrorRecordAttachmentExtension
object
Bad request error. The specified filename does not include a supported extension.
3 properties
BadRequestErrorContractAction
object
3 properties
3 required
EntityProperties
object
The entity properties associated with the entity
UndoContractAction
object
2 properties
2 required
RecordPropertyBoolean
object
A true/false boolean-type record property
3 properties
2 required
SourcedFromWorkflow
object
Record created from an Ironclad workflow
2 properties
2 required
SourcedFromContract
object
Record created from a contract (typically an obligation)
2 properties
2 required
BadRequestErrorRecordAttachmentAlreadyExists
object
Bad request error. The specified attachment key has an existing file.
3 properties
RecordPropertyLinkModel
object
1 property
1 required
BadRequestErrorRecordAttachmentIDNotFound
object
Record Attachment ID Not Found Request Error
2 properties
SourcedFromImportProject
object
Record created from an import project
2 properties
2 required
RecordModel
object
14 properties
8 required
SourcedFromClickwrap
object
Record created from a clickwrap agreement
2 properties
2 required
SourcedFromAiChat
object
Record created from an AI chat
2 properties
2 required
ExtendContractAction
object
2 properties
2 required
EditRenewalContractAction
object
2 properties
2 required
PropertiesToAmend
object
Configuration specifying which properties should be amended from this amendment record to its parent. Keys are property names, values define the amendment beha…
RecordPropertyReference
object
A reference-type record property that points to another record
3 properties
2 required
SmartImportRetrievePredictionsResponseElement
object
2 properties
2 required
SourcedFromSingleImport
object
Record created from a single import
1 property
1 required
BadRequestErrorRecordAttachmentMissingFormDataPart
object
Bad request error. Missing form-data part.
3 properties
RenewalContractActionProperties
object
SourcedFromConnector
object
Record created from a connector integration
2 properties
2 required
BadRequestErrorRecordAttachmentUnknownContentType
object
Bad request error. Unknown content type.
3 properties
RecordProperties
object
The record properties associated with the record
RecordPropertyAddress
object
An address-type record property
3 properties
2 required
RecordPropertyDate
object
A date-type record property
3 properties
2 required
ActivateContractAction
object
2 properties
2 required
RecordPropertyClause
object
A clause-type record property
2 properties
2 required
ClauseLanguagePositionCustom
object
A custom clause language position
1 property
1 required
LinkType
string
Identifies the type of relationship this child record has with its parent (e.g. amendment)
BadRequestErrorRecordAttachmentUnknownAttachmentKey
object
Bad request error. Unknown record attachment key.
3 properties
RecordPropertyType
object
RecordPropertyDuration
object
A duration-type record property
3 properties
2 required
CancelAutoRenewalContractAction
object
1 property
1 required
RecordParentModel
object
Object containing Record IDs or Ironclad IDs to be set as the parent of the current record.
2 properties
1 required
RecordPropertyNumber
object
A number-type record property
3 properties
2 required
RecordPropertyEmail
object
An email-type record property
3 properties
2 required
RecordPropertyMonetaryAmount
object
A monetary amount-type record property
3 properties
2 required
RenewalTermLengthContractActionProperties
object
1 property
ContractAction
object
TerminateContractAction
object
2 properties
2 required
BadRequestErrorRecordIDNotFound
object
Record ID Not Found Request Error
2 properties
EntityPropertyType
object
RenewalTypeContractActionProperties
object
2 properties
1 required
SourcedFromMetadataImport
object
Record created from a metadata import
2 properties
2 required
RollUpConfiguration
object
1 property
1 required
SupersedeContractAction
object
2 properties
2 required
RecordPropertyString
object
A text-type record property
3 properties
2 required
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 Resources API
Ironclad Schemas API
Ironclad Search API
Ironclad Users API
Ironclad Webhooks API
Ironclad Workflows API
#Records