How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Ironclad

Ironclad Records API

Documentation on Ironclad Records.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 1.

Requests are made against 3 base URLs: https://na1.ironcladapp.com/public/api/v1, https://eu1.ironcladapp.com/public/api/v1, https://demo.ironcladapp.com/public/api/v1.

17 operations 10 paths 55 schemas 2 DELETE7 GET1 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://na1.ironcladapp.com/public/api/v1
Authentication
API Key, OAuth 2.0
Contact
Ironclad Support
Resource Areas
1

Authentication & Security 2

Ironclad Records API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (sec0). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 60 scopes.

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
list-all-records 11 params → 200400
POST
/records
Create a Record
create-a-record 3 params body → 200400403
POST
/records/attachments/download-urls
Create Attachment Download URLs
create-attachment-download-urls 2 params body → 202400401403
GET
/records/attachments/download-urls/{jobId}
Get Attachment Download URLs Status
get-attachment-download-urls-status 3 params → 200401403404
GET
/records/smart-import
Retrieve Predictions
retrieve-import-predictions 4 params → 200400403404
POST
/records/smart-import
Create a Smart Import Record
create-a-smart-import-record 2 params body → 200400403404
POST
/records/smart-import/{importId}
Upload a Smart Import Record to an existing Import
create-a-smart-import-record-to-import 3 params body → 200400403404
GET
/records/{id}
Retrieve a Record
retrieve-a-record 5 params → 200400
PUT
/records/{id}
Replace a Record
replace-a-record 4 params body → 200400
DELETE
/records/{id}
Delete a Record
delete-a-record 3 params → 204400
PATCH
/records/{id}
Update Record Metadata
update-record-metadata 4 params body → 200400404
GET
/records/metadata
Retrieve Records Schema
list-all-records-metadata 2 params → 200400
POST
/records/{id}/attachments/{key}
Create an Attachment on a Record
create-an-attachment-on-a-record 5 params body → 200400
GET
/records/{id}/attachments/{key}
Retrieve an Attachment on a Record
retrieve-an-attachment-on-a-record 4 params → 200400
DELETE
/records/{id}/attachments/{key}
Delete an Attachment on a Record
delete-an-attachment-on-a-record 4 params → 204404
POST
/records/{id}/actions
Run an Action on a Record
run-an-action-on-a-record 1 param body → 200400403404
GET
/records/export
Retrieve XLSX Export File of Records
retrieve-xlsx-export-file-of-all-records 4 params → 200400

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are RecordModel (14 properties), RecordPropertyEmail (3 properties), RecordPropertyBoolean (3 properties), BadRequestErrorRecordAttachmentMissingFormDataPart (3 properties). Each schema is shown below with its type and property counts.

SourcedFromAiChat
object
Record created from an AI chat
2 properties 2 required
RecordProperties
object
The record properties associated with the record
CancelAutoRenewalContractAction
object
1 property 1 required
RecordModel
object
14 properties 8 required
SourcedFromIntegration
object
Record created from an integration
2 properties 2 required
RecordPropertyDuration
object
A duration-type record property
3 properties 2 required
BadRequestErrorRecordAttachmentUnknownContentType
object
Bad request error. Unknown content type.
3 properties
BadRequestErrorRecordIDNotFound
object
Record ID Not Found Request Error
2 properties
EditRenewalContractAction
object
2 properties 2 required
SourcedFromWorkflow
object
Record created from an Ironclad workflow
2 properties 2 required
SourcedFromSingleImport
object
Record created from a single import
1 property 1 required
RecordPropertyClause
object
A clause-type record property
2 properties 2 required
RecordPropertyReference
object
A reference-type record property that points to another record
3 properties 2 required
RecordPropertyNumber
object
A number-type record property
3 properties 2 required
BadRequestErrorRecordAttachmentUnknownAttachmentKey
object
Bad request error. Unknown record attachment key.
3 properties
BadRequestErrorRecordAttachmentExtension
object
Bad request error. The specified filename does not include a supported extension.
3 properties
SmartImportRetrievePredictionsResponseElement
object
2 properties 2 required
ClauseLanguagePositionPlaybook
object
A playbook clause language position
3 properties 3 required
RecordPropertyPlaybookClause
object
A playbook-based clause-type record property
2 properties 2 required
BadRequestErrorRecordAttachmentIDNotFound
object
Record Attachment ID Not Found Request Error
2 properties
SupersedeContractAction
object
2 properties 2 required
RecordPropertyDate
object
A date-type record property
3 properties 2 required
RecordPropertyArray
object
An array-type record property
2 properties 2 required
RecordPropertyString
object
A text-type record property
3 properties 2 required
RenewalTypeContractActionProperties
object
2 properties 1 required
SourcedFromClickwrap
object
Record created from a clickwrap agreement
2 properties 2 required
BadRequestErrorContractAction
object
3 properties 3 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…
BadRequestErrorRecordNotFound
object
Bad request error. The specified record does not exist.
2 properties
TerminateContractAction
object
2 properties 2 required
RecordPropertyAddress
object
An address-type record property
3 properties 2 required
RecordParentModel
object
Object containing Record IDs or Ironclad IDs to be set as the parent of the current record.
2 properties 1 required
RecordPropertyMonetaryAmount
object
A monetary amount-type record property
3 properties 2 required
BadRequestErrorRecordAttachmentAlreadyExists
object
Bad request error. The specified attachment key has an existing file.
3 properties
UndoContractAction
object
2 properties 2 required
RecordPropertyType
object
ContractAction
object
ExtendContractAction
object
2 properties 2 required
BadRequestErrorRecordAttachmentMissingFormDataPart
object
Bad request error. Missing form-data part.
3 properties
RecordPropertyBoolean
object
A true/false boolean-type record property
3 properties 2 required
ClauseLanguagePositionCustom
object
A custom clause language position
1 property 1 required
EntityPropertyType
object
RenewalTermLengthContractActionProperties
object
1 property
RecordPropertyEmail
object
An email-type record property
3 properties 2 required
RollUpConfiguration
object
1 property 1 required
RenewalContractActionProperties
object
LinkType
string
Identifies the type of relationship this child record has with its parent (e.g. amendment)
SourcedFromImportProject
object
Record created from an import project
2 properties 2 required
SourcedFromConnector
object
Record created from a connector integration
2 properties 2 required
RecordPropertyLinkModel
object
1 property 1 required
SourcedFromMetadataImport
object
Record created from a metadata import
2 properties 2 required
EffectiveContractActionProperties
object
2 properties
SourcedFromContract
object
Record created from a contract (typically an obligation)
2 properties 2 required
EntityProperties
object
The entity properties associated with the entity
ActivateContractAction
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironclad-records-api-openapi.yml Raw ↑

Other APIs Ironclad publishes across the network.

Ironclad Clickwrap API
AE Profile APIs.io
Ironclad Authorization API
AE Profile APIs.io
Ironclad Entities API
AE Profile APIs.io
Ironclad Exports API
AE Profile APIs.io
Ironclad Groups API
AE Profile APIs.io
Ironclad Obligations API
AE Profile APIs.io
Ironclad Resources API
AE Profile APIs.io
Ironclad Schemas API
AE Profile APIs.io
Ironclad Search API
AE Profile APIs.io
Ironclad Users API
AE Profile APIs.io
Ironclad Webhooks API
AE Profile APIs.io
Ironclad Workflows API
AE Profile APIs.io
#Records
← Back to I APIs
API Details
ID
ironclad:ironclad-records-api
Base URL
https://na1.ironcladapp.com/public/api/v1
Docs
https://developer.ironcladapp.com/reference/getting-started-api
Provider
Ironclad
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ironclad-records-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ironclad-records-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Ironclad Records API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.