AgreementTemplate

object

keyrequired: string
originrequired: "system" | "company"
system_keyrequired: string or null
kindrequired: AgreementDocumentKind
statesrequired: array of string
titlerequired: string
descriptionrequired: string or null
executionrequired: AgreementExecution
versionrequired: integer
statusrequired: "active" | "archived"
updated_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
blocksrequired: array of AgreementTemplateBlock
slotsrequired: array of object
slots[].keyrequired: string
slots[].requiredrequired: boolean
slots[].includedrequired: boolean
versionsrequired: array of object
versions[].versionrequired: integer
versions[].titlerequired: string
versions[].change_noterequired: string or null
versions[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
versions[].created_byrequired: object or null
versions[].created_by.idrequired: Id
Opaque record id.
versions[].created_by.namerequired: string
problemsrequired: array of string
editablerequired: boolean

Example

{
  "key": "string",
  "origin": "system",
  "system_key": "string",
  "kind": "leave_licence",
  "states": [
    "string"
  ],
  "title": "string",
  "description": "string",
  "execution": "notarised",
  "version": 0,
  "status": "active",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "blocks": [
    {
      "kind": "heading",
      "text": "string"
    }
  ],
  "slots": [
    {
      "key": "string",
      "required": true,
      "included": true
    }
  ],
  "versions": [
    {
      "version": 0,
      "title": "string",
      "change_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    }
  ],
  "problems": [
    "string"
  ],
  "editable": true
}