Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ironclad Obligations API

Documentation on Ironclad Obligations.

Ironclad Obligations 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 Obligations. 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 4 operations across 2 paths, and defines 20 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.

4 operations 2 paths 20 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://na1.ironcladapp.com/public/api/v1
Resource Areas
1

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Obligations 4

Documentation on Ironclad Obligations.

GET
/obligations
List All Obligations
list-all-obligations 7 params → 200400401403404
POST
/obligations
Create an Obligation
create-an-obligation 2 params body → 201400401403
GET
/obligations/{id}
Retrieve an Obligation
retrieve-an-obligation 3 params → 200400401403404
PATCH
/obligations/{id}
Update an Obligation
update-an-obligation 3 params body → 200400401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ObligationModel (8 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
RecordPropertyArray
object
An array-type record property
2 properties 2 required
RecordPropertyPlaybookClause
object
A playbook-based clause-type record property
2 properties 2 required
RecordPropertyBoolean
object
A true/false boolean-type record property
3 properties 2 required
ObligationModel
object
8 properties 4 required
RecordPropertyReference
object
A reference-type record property that points to another record
3 properties 2 required
RecordPropertyAddress
object
An address-type record property
3 properties 2 required
RecordProperties
object
The record properties associated with the record
RecordPropertyDate
object
A date-type record property
3 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
RecordPropertyDuration
object
A duration-type record property
3 properties 2 required
RecordPropertyType
object
ObligationTypeKey
array
The key of the obligation type to be added to the obligation. Only one obligation type can be added or updated per obligation, currently. More info on obligati…
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
EntityPropertyType
object
EntityProperties
object
The entity properties associated with the entity
RecordPropertyString
object
A text-type record property
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironclad-obligations-api-openapi.yml Raw ↑

Other APIs Ironclad publishes across the network.

Ironclad Clickwrap API
Ironclad Authorization API
Ironclad Entities API
Ironclad Exports API
Ironclad Groups API
Ironclad Records API
Ironclad Resources API
Ironclad Schemas API
Ironclad Search API
Ironclad Users API
Ironclad Webhooks API
Ironclad Workflows API