/

Get agreement templates

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

organizationIdintegerOptional

The ID of the organization

Default: 1Example: 1

namestringOptional

The name of the agreement template

Default: Template AExample: Template A

Responses

200Success

application/json

get

/api/agreement-templates/

HTTPcURLJavaScriptPython

GET /api/agreement-templates/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 1,
    "organizationId": 1,
    "name": "Standard Agreement",
    "userAction": "ConsumerOnboarding",
    "contentHtml": "<p>Agreement content here</p>",
    "fields": [],
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
]

Create agreement

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

idintegerRequired

The unique identifier for the agreement template

Default: 1Example: 1

organizationIdintegerOptional

The ID of the organization associated with the agreement template

Default: 1Example: 1

namestringRequired

The name of the agreement template

Default: Standard AgreementExample: Standard Agreement

userActionstring · enumRequired

The user action associated with the agreement template

Default: ConsumerOnboardingExample: ConsumerOnboardingPossible values:

contentHtmlstringRequired

The HTML content of the agreement template

Default: <p>Agreement content here</p>Example: <p>Agreement content here</p>

createdAtone ofRequired

The date when the agreement template was created

Default: 2023-01-01T00:00:00ZExample: 2023-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

updatedAtone ofRequired

The date when the agreement template was last updated

Default: 2023-01-01T00:00:00ZExample: 2023-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

Responses

200Success

application/json

post

/api/agreement-templates/

HTTPcURLJavaScriptPython

POST /api/agreement-templates/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "id": 1,
  "organizationId": 1,
  "name": "Standard Agreement",
  "userAction": "ConsumerOnboarding",
  "contentHtml": "<p>Agreement content here</p>",
  "fields": [],
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}

200Success

{
  "id": "12345",
  "agreementTemplateId": 1,
  "surveyResponseId": 1,
  "personId": 1,
  "files": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "resource": null,
      "cloudId": "text",
      "cloudUrl": "text",
      "scanStatus": "text",
      "mimeType": "text",
      "personId": 1,
      "createdAt": "2026-02-07",
      "updatedAt": "2026-02-07",
      "attributes": {},
      "archived": true,
      "healthRecordAttributeFile": [
        {
          "id": 12,
          "fileId": 12,
          "healthRecordAttributeId": 12,
          "notes": "This is example file",
          "createdAt": "2023-03-02 07:14:19.987",
          "updatedAt": "2023-03-02 07:14:19.987"
        }
      ],
      "labels": {},
      "relatedFiles": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "resource": null,
          "cloudId": "text",
          "cloudUrl": "text",
          "scanStatus": "text",
          "mimeType": "text",
          "personId": 1,
          "createdAt": "2026-02-07",
          "updatedAt": "2026-02-07",
          "attributes": {},
          "archived": true,
          "healthRecordAttributeFile": [
            {
              "id": 12,
              "fileId": 12,
              "healthRecordAttributeId": 12,
              "notes": "This is example file",
              "createdAt": "2023-03-02 07:14:19.987",
              "updatedAt": "2023-03-02 07:14:19.987"
            }
          ],
          "labels": {},
          "relatedFiles": [
            "[Circular Reference]"
          ],
          "relatedFile": [
            "[Circular Reference]"
          ],
          "isRelatedFile": true,
          "updatedBy": {},
          "person": {
            "id": 1,
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01",
            "gender": "MALE",
            "mobile": "[phone]",
            "email": "[email protected]",
            "uuid": "uuid-1234",
            "externalId": "external-1234",
            "currency": "USD",
            "consumer": "{}",
            "serviceProvider": "{}"
          }
        }
      ],
      "relatedFile": [
        {
          "id": 1,
          "fromFileId": 1,
          "toFileId": 1,
          "fromFile": {
            "id": 1,
            "name": "text",
            "description": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "personId": 1,
            "createdAt": "2026-02-07",
            "updatedAt": "2026-02-07",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 12,
                "fileId": 12,
                "healthRecordAttributeId": 12,
                "notes": "This is example file",
                "createdAt": "2023-03-02 07:14:19.987",
                "updatedAt": "2023-03-02 07:14:19.987"
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "relatedFile": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {},
            "person": {
              "id": 1,
              "firstName": "John",
              "lastName": "Doe",
              "birthDate": "1990-01-01",
              "gender": "MALE",
              "mobile": "[phone]",
              "email": "[email protected]",
              "uuid": "uuid-1234",
              "externalId": "external-1234",
              "currency": "USD",
              "consumer": "{}",
              "serviceProvider": "{}"
            }
          },
          "toFile": {
            "id": 1,
            "name": "text",
            "description": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "personId": 1,
            "createdAt": "2026-02-07",
            "updatedAt": "2026-02-07",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 12,
                "fileId": 12,
                "healthRecordAttributeId": 12,
                "notes": "This is example file",
                "createdAt": "2023-03-02 07:14:19.987",
                "updatedAt": "2023-03-02 07:14:19.987"
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "relatedFile": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {},
            "person": {
              "id": 1,
              "firstName": "John",
              "lastName": "Doe",
              "birthDate": "1990-01-01",
              "gender": "MALE",
              "mobile": "[phone]",
              "email": "[email protected]",
              "uuid": "uuid-1234",
              "externalId": "external-1234",
              "currency": "USD",
              "consumer": "{}",
              "serviceProvider": "{}"
            }
          },
          "createdAt": "2026-02-07",
          "updatedAt": "2026-02-07"
        }
      ],
      "isRelatedFile": true,
      "updatedBy": {},
      "person": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01",
        "gender": "MALE",
        "mobile": "[phone]",
        "email": "[email protected]",
        "uuid": "uuid-1234",
        "externalId": "external-1234",
        "currency": "USD",
        "consumer": "{}",
        "serviceProvider": "{}"
      }
    }
  ],
  "agreementTemplate": [
    {
      "id": 1,
      "organizationId": 1,
      "name": "Standard Agreement",
      "userAction": "ConsumerOnboarding",
      "contentHtml": "<p>Agreement content here</p>",
      "fields": [],
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  ],
  "surveyResponse": null,
  "person": null,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}