Ironclad Contracts

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` A source obligation is the definition; an instance (occurrence) is a single occurrence of it. To record an occurrence, pass the source obligation's ID as `sourceObligationId` — find one with list_obligations (its `obligationType` is `SOURCE`). Do not pass an instance's ID. This API only creates `TRIGGERED` occurrences; recurring occurrences are generated automatically by Ironclad and cannot be created or deleted here. The response includes a `url` to view the created obligation in the Ironclad UI — present it to the user.

create_obligation

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`

list_obligation_types

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` Each obligation in the response includes a `url` to view it in the Ironclad UI — present these to the user. This endpoint is paginated. The response includes `count` (total results matching the query across ALL pages) plus the current `page` and `pageSize`. Narrow before you page: use `filter` and/or `search` to request only the records you need, or `get_obligation` when you already know the record's ID. When you do enumerate a filtered result set and `count` exceeds the results retrieved so far, request the next `page` — repeating the same `filter`/`search`/sort and changing only `page` — until you have them all, so matches beyond the first page are not missed. Do NOT paginate the entire unfiltered set to find or aggregate a subset; narrow the query with `filter`/`search` instead.

list_obligations

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`

get_obligation

Ask a natural language question and get an AI-generated response grounded in your contracts and records. **OAuth Scopes required:** `public.search.conversational`, `public.records.readRecords`, `public.workflows.readWorkflows` **Prerequisites:** Conversational Search must be enabled for your company. If you receive a `403` error, please ask your company administrator to enable the Conversational Search feature in your company settings. Performance guidance: Prefer modelTier="ultrafast" by default. Higher tiers can significantly increase latency and timeout risk. Only use "fast", "standard", or "powerful" if the user explicitly asks for the tier or for maximum quality over speed, or if prior lower tiers were clearly insufficient. Results returned are based on information retrieved from your Ironclad instance, are provided for informational purposes only, and do not constitute legal or other professional services advice. Full terms: https://legal.ironcladapp.com/

conversational_search

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` A source obligation is the definition; an instance (occurrence) is a single occurrence of it. To record an occurrence, pass the source obligation's ID as `sourceObligationId` — find one with list_obligations (its `obligationType` is `SOURCE`). Do not pass an instance's ID. This API only creates `TRIGGERED` occurrences; recurring occurrences are generated automatically by Ironclad and cannot be created or deleted here. The response includes a `url` to view the updated obligation in the Ironclad UI — present it to the user.

update_obligation