Agreements

User agreements, waivers, and consent management.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

includeDraftsbooleanOptional

Include draft agreements

Example: false

expandstring[]OptionalExample: ["items._links.area","items._links.releasedBy"]

typeanyOptionalExample: AREA_LIABILITY_WAIVER

Responses

200

Returns an AgreementCollection

application/json

_totalnumberRequired

get/agreements

GET /apis/v2/agreements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an AgreementCollection

{
  "items": [
    {
      "id": "text",
      "displayName": "text",
      "type": "TERMS_OF_SERVICE",
      "area": {
        "id": "text"
      },
      "content": "text",
      "releasedAt": "2026-01-01T00:00:00.000Z",
      "contentType": "URL",
      "status": "DRAFT",
      "complianceType": "MANDATORY",
      "errors": [
        {
          "code": "text",
          "message": "text",
          "details": {}
        }
      ],
      "releasedBy": {
        "id": "text"
      },
      "_links": {}
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

Responses

201

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

422

Returns an ErrorDto in case of validation errors or failures.

post/agreements

POST /apis/v2/agreements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "_links": {}
}

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

get/agreements/liability-waiver

GET /apis/v2/agreements/liability-waiver HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an Agreement

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

get/agreements/kids-waiver

GET /apis/v2/agreements/kids-waiver HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an Agreement

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

agreementIdstringRequiredExample: aa27a2ae-8235-426d-91ad-6e30cb494b2b

Query parameters

expandstring[]OptionalExample: ["_links.area","_links.releasedBy"]

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

get/agreements/{agreementId}

GET /apis/v2/agreements/{agreementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an Agreement

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

agreementIdstringRequired

Body

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

403

Returns an Agreement

application/json

patch/agreements/{agreementId}

PATCH /apis/v2/agreements/{agreementId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "_links": {}
}

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

areaIdstringRequiredExample: williamsburg

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

get/agreements/{areaId}/liability-waiver

GET /apis/v2/agreements/{areaId}/liability-waiver HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an Agreement

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

areaIdstringRequiredExample: williamsburg

Responses

200

Returns an Agreement

application/json

idstringRead-onlyRequired

displayNamestringRead-onlyRequired

typestring · enumRequiredPossible values:

contentstringRequired

releasedAtstring · date-timeRead-onlyRequired

contentTypestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

complianceTypestring · enumRequiredPossible values:

_linksobjectRequired

get/agreements/{areaId}/kids-waiver

GET /apis/v2/agreements/{areaId}/kids-waiver HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns an Agreement

{
  "id": "text",
  "displayName": "text",
  "type": "TERMS_OF_SERVICE",
  "area": {
    "id": "text"
  },
  "content": "text",
  "releasedAt": "2026-01-01T00:00:00.000Z",
  "contentType": "URL",
  "status": "DRAFT",
  "complianceType": "MANDATORY",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "releasedBy": {
    "id": "text"
  },
  "_links": {}
}