Agreements Version APIs

Provides the functionality to manage, record, and track agreements for orgs, apps, and experiments.

Retrieve all versions of a specific agreement

get

This endpoint allows users to fetch all available versions of a specified agreement. It provides visibility into the historical changes and updates made to the agreement, ensuring users can track its evolution over time. Ideal for organizations needing to manage their agreements effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/agreements/{agreementId}/versions

HTTPcURLJavaScriptPython

GET /directory/orgs/{organizationId}/agreements/{agreementId}/versions HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "major": {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2026-02-13T01:25:47.357Z",
      "effective_date": "2026-02-13T01:25:47.357Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2026-02-13T01:25:47.357Z",
          "date_modified": "2026-02-13T01:25:47.357Z"
        }
      ],
      "status": "draft"
    },
    "active": true,
    "minors": [
      {
        "id": "text",
        "version_number": "text",
        "version_type": "minor",
        "modified_date": "2026-02-13T01:25:47.357Z",
        "effective_date": "2026-02-13T01:25:47.357Z",
        "scopes": [
          {
            "id": "text",
            "sensitivity": "text",
            "purpose": [
              "COLLECTION"
            ]
          }
        ],
        "content": [
          {
            "url": "text",
            "title": "text",
            "locale": "text",
            "mime_type": "text",
            "date_created": "2026-02-13T01:25:47.357Z",
            "date_modified": "2026-02-13T01:25:47.357Z"
          }
        ],
        "status": "draft"
      }
    ],
    "validation": {
      "ANY_ADDITIONAL_PROPERTY": {
        "errors": [
          "text"
        ]
      }
    }
  }
}

Add a major version to an agreement

post

This endpoint allows users to add a major version to an existing agreement. It is intended for managing agreement versions within the organization. Ensure that the provided agreement ID and version type are valid to successfully update the agreement.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

typestringRequired

Body

application/json

major_versionstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{type}

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{type} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "major_version": "text"
}

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Retrieve a specific version of an agreement.

get

This endpoint allows users to access a particular version of an agreement by its ID. It is essential for tracking changes and managing agreements effectively. Ensure you have the necessary permissions to view this version.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}

HTTPcURLJavaScriptPython

GET /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Update a specific version of an agreement

put

This endpoint allows users to update a specific version of an agreement identified by its ID. It requires the agreement ID and version ID as path variables, along with the updated details in the request body. Proper authentication is necessary to ensure secure access to this operation.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

Body

application/json

effective_datestring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}

HTTPcURLJavaScriptPython

PUT /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "scopes": [
    {
      "id": "text",
      "category": "text",
      "subcategory": "text",
      "label": {
        "en": "text",
        "jp": "text"
      },
      "org_id": "text",
      "status": "test",
      "description": {
        "en": "text",
        "jp": "text"
      },
      "sensitivity": "High",
      "visible": true
    }
  ],
  "effective_date": "2026-02-13T01:25:47.357Z"
}

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Delete a specific version of an agreement.

delete

This endpoint allows users to delete a specific version of an agreement identified by agreementId and versionId. It is crucial for maintaining the integrity of agreement records. Ensure that the user has the necessary permissions to perform this action.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}

HTTPcURLJavaScriptPython

DELETE /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Create a new major version of an agreement

post

This endpoint allows users to create a copy of an existing agreement version. It is designed for managing agreement versions within an organization. Ensure that the necessary permissions are in place to access and modify agreement details.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

typestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/copy/{type}

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/copy/{type} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Retrieve validation details for a specific agreement version

get

This endpoint allows users to obtain validation information for a specific version of an agreement. It is essential for ensuring compliance and correctness in agreement management. The operation is intended for authorized users to verify the integrity of agreement versions.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/errors

HTTPcURLJavaScriptPython

GET /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/errors HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errors": [
    "text"
  ]
}

Publish a specific version of an agreement

post

This endpoint allows users to publish a designated version of an agreement. It is essential for managing the lifecycle of agreements within the organization. Ensure that the correct version ID is provided for successful publication.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/publish

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/publish HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errors": [
    "text"
  ]
}

Remove a specific version of an agreement

delete

This endpoint allows users to remove a specific version of an agreement. It is essential for maintaining the accuracy and relevance of agreement records. Ensure that the correct version ID is provided to avoid unintentional deletions.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

languagestringRequired

Body

application/json

stringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}

HTTPcURLJavaScriptPython

DELETE /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Update content for a specific agreement version

post

This endpoint allows users to update the content associated with a specific version of an agreement. It is designed for managing agreement details effectively. Ensure that the correct agreementId and versionId are provided for accurate updates.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

languagestringRequired

Body

application/json

urlstringOptional

titlestringOptional

mime_typestringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/content

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/content HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "text",
  "title": "text",
  "mime_type": "text"
}

{
  "url": "text",
  "title": "text",
  "locale": "text",
  "mime_type": "text",
  "date_created": "2026-02-13T01:25:47.357Z",
  "date_modified": "2026-02-13T01:25:47.357Z"
}

Delete content for a specific agreement version

delete

This endpoint allows users to delete content associated with a specific version of an agreement. It is crucial for maintaining the accuracy and relevance of agreement data. Ensure that the correct version and language are specified to avoid unintended deletions.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

languagestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/content

HTTPcURLJavaScriptPython

DELETE /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/content HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "version_number": "text",
  "version_type": "minor",
  "modified_date": "2026-02-13T01:25:47.357Z",
  "effective_date": "2026-02-13T01:25:47.357Z",
  "scopes": [
    {
      "id": "text",
      "sensitivity": "text",
      "purpose": [
        "COLLECTION"
      ]
    }
  ],
  "content": [
    {
      "url": "text",
      "title": "text",
      "locale": "text",
      "mime_type": "text",
      "date_created": "2026-02-13T01:25:47.357Z",
      "date_modified": "2026-02-13T01:25:47.357Z"
    }
  ],
  "status": "draft"
}

Upload content for an agreement version.

post

This endpoint allows users to upload content associated with a specific agreement version. The uploaded content is identified by the agreement ID and version ID, ensuring proper management of agreement materials. This functionality is essential for maintaining up-to-date agreement documentation.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

agreementIdstringRequired

versionIdstringRequired

languagestringRequired

Query parameters

filenamestringRequired

Body

application/json

string · byteOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/upload

HTTPcURLJavaScriptPython

POST /directory/orgs/{organizationId}/agreements/{agreementId}/versions/{versionId}/{language}/upload?filename=text HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

{
  "url": "text",
  "mime_type": "text"
}