Skip to main content

Get All Agreements

GET /v1/agreement

Retrieves a list of available agreements. Results can be filtered by agreement type and extended with additional data such as service lists. Returns agreements with their content, status, tenant scope, and metadata.

Query Parameters​

  • type - Filter by type or category
  • extended[] - Parameter for extended[]

Request Example​

GET /v1/agreement

Response Example​

[
  {
    "_id": "agreement-id-1",
    "content": {
      "en": {
        "title": "User Agreement",
        "description": "Terms and conditions for using our services.",
        "body": "{\"blocks\":[{\"key\":\"a1b2c\",\"text\":\"By continuing to use our services, you agree to comply with the terms and conditions stated in this agreement.\",\"type\":\"unstyled\",\"depth\":0,\"inlineStyleRanges\":[],\"entityRanges\":[],\"data\":{}}],\"entityMap\":{}}"
      }
    },
    "services": ["service-id-1", "service-id-2"],
    "active": true,
    "global": false,
    "reconsent": true,
    "tenant": "tenant-id-1",
    "type": "USER",
    "created": "2025-04-02T16:01:45.209Z",
    "updated": "2025-08-14T16:51:16.832Z"
  }
]