Agreements API

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

List agreements for the specified organization

get

Retrieves all agreements associated with the given organization ID. This endpoint provides visibility into the agreements defined for the organization, ensuring compliance with privacy standards and regulations.

👤 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

organizationIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/orgs/{organizationId}/agreements

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "limit": 1,
  "skip": 1,
  "docs": [
    {
      "id": "text",
      "name": "text",
      "org_id": "text",
      "namespace": "org",
      "object_id": "org",
      "description": "text",
      "versions": [
        {
          "id": "text",
          "version_number": "text",
          "version_type": "minor",
          "modified_date": "2025-12-16T22:05:02.487Z",
          "effective_date": "2025-12-16T22:05:02.487Z",
          "scopes": [
            {
              "id": "text",
              "sensitivity": "text",
              "purpose": [
                "COLLECTION"
              ]
            }
          ],
          "content": [
            {
              "url": "text",
              "title": "text",
              "locale": "text",
              "mime_type": "text",
              "date_created": "2025-12-16T22:05:02.487Z",
              "date_modified": "2025-12-16T22:05:02.487Z"
            }
          ],
          "status": "draft"
        }
      ],
      "status": "test",
      "type": "privacy_policy",
      "date_created": "2025-12-16T22:05:02.487Z",
      "date_modified": "2025-12-16T22:05:02.487Z",
      "owner": {
        "email": "text"
      }
    }
  ]
}

Create a new agreement for the organization

post

This endpoint allows users to create a new agreement that can be utilized by the specified organization. It is essential for managing compliance with privacy regulations and ensuring proper documentation of agreements. Use this to establish new terms for users within the organization.

👤 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

organizationIdstringRequired

Body

application/json

idstringOptional

namestringOptional

org_idstringOptional

namespacestring · enumOptionalPossible values:

object_idstring · enumOptionalPossible values:

descriptionstringOptional

statusstring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

date_createdstring · date-timeOptional

date_modifiedstring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/directory/orgs/{organizationId}/agreements

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}

Retrieve a specific organization agreement

get

Fetches the details of a specific agreement for the given organization. This endpoint is essential for understanding the terms and conditions that apply to the organization. It ensures compliance with privacy regulations and provides users with the necessary information regarding their agreements.

👤 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

organizationIdstringRequired

agreementIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

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

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}

Update an existing organization agreement

put

This endpoint allows you to update an existing agreement for a specified organization. It ensures that the agreement details are modified according to the provided input. This operation is crucial for maintaining accurate records of agreements in compliance with privacy regulations.

👤 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

organizationIdstringRequired

agreementIdstringRequired

Body

application/json

idstringOptional

namestringOptional

org_idstringOptional

namespacestring · enumOptionalPossible values:

object_idstring · enumOptionalPossible values:

descriptionstringOptional

statusstring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

date_createdstring · date-timeOptional

date_modifiedstring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

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

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}

Delete an organization's agreement.

delete

This endpoint allows for the removal of an existing agreement for a specified organization. It ensures that the agreement is no longer valid and updates the organization's records accordingly. Use this operation to manage compliance and privacy 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

organizationIdstringRequired

agreementIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

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

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "org_id": "text",
  "namespace": "org",
  "object_id": "org",
  "description": "text",
  "versions": [
    {
      "id": "text",
      "version_number": "text",
      "version_type": "minor",
      "modified_date": "2025-12-16T22:05:02.487Z",
      "effective_date": "2025-12-16T22:05:02.487Z",
      "scopes": [
        {
          "id": "text",
          "sensitivity": "text",
          "purpose": [
            "COLLECTION"
          ]
        }
      ],
      "content": [
        {
          "url": "text",
          "title": "text",
          "locale": "text",
          "mime_type": "text",
          "date_created": "2025-12-16T22:05:02.487Z",
          "date_modified": "2025-12-16T22:05:02.487Z"
        }
      ],
      "status": "draft"
    }
  ],
  "status": "test",
  "type": "privacy_policy",
  "date_created": "2025-12-16T22:05:02.487Z",
  "date_modified": "2025-12-16T22:05:02.487Z",
  "owner": {
    "email": "text"
  }
}