Get Agreement By Id

GET /v1/agreement/:id

Retrieves detailed information for a single agreement by its unique identifier. The response includes the agreement content, associated services, status flags, tenant scope, and metadata.

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"],
  "service": {
    "_id": "service-id-1",
    "name": "Example Service"
  },
  "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"
}