cURL

curl -X GET \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  "https://api.clickterm.com/public-client/v1/clickwrap-templates?tags=registrationOnly&tags=required"

[
  {
    "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999",
    "clickwrapTemplateName": "Terms of Service",
    "clickwrapTemplateVersion": 2,
    "clickwrapTemplateVersionMinor": 0,
    "tags": [
      "registration",
      "customer_only"
    ],
    "effectiveAt": "2025-08-20T14:00:00Z",
    "mustAcceptBy": null
  },
  {
    "clickwrapTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "clickwrapTemplateName": "Privacy Policy",
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 3,
    "tags": [],
    "effectiveAt": "2025-09-01T00:00:00Z",
    "mustAcceptBy": "2025-10-01T00:00:00Z"
  }
]

Get templates by tags

Retrieve enabled clickwrap templates for your app, optionally filtered by tags. Returns template metadata including the effective version, tags, and optional acceptance deadline.

Templates can be configured with custom tags in the ClickTerm UI to support flexible categorization (e.g., user types, registration-only flags, required flows).

Authenticated — requires X-APP-ID and X-APP-KEY headers.

When at least one template is linked to your app in the dashboard, only linked templates are returned. If no templates are linked, all enabled templates are returned.

GET

clickwrap-templates

cURL

curl -X GET \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  "https://api.clickterm.com/public-client/v1/clickwrap-templates?tags=registrationOnly&tags=required"

[
  {
    "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999",
    "clickwrapTemplateName": "Terms of Service",
    "clickwrapTemplateVersion": 2,
    "clickwrapTemplateVersionMinor": 0,
    "tags": [
      "registration",
      "customer_only"
    ],
    "effectiveAt": "2025-08-20T14:00:00Z",
    "mustAcceptBy": null
  },
  {
    "clickwrapTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "clickwrapTemplateName": "Privacy Policy",
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 3,
    "tags": [],
    "effectiveAt": "2025-09-01T00:00:00Z",
    "mustAcceptBy": "2025-10-01T00:00:00Z"
  }
]

Authorizations

X-APP-ID

string

header

required

Your application's App ID, sent as the X-APP-ID header. Must be accompanied by X-APP-KEY for authenticated endpoints.

X-APP-KEY

string

header

required

Your application's secret App Key (server-side only)

Query Parameters

Response

200 - application/json

Templates retrieved

clickwrapTemplateId

string<uuid>

Unique identifier of the clickwrap template

clickwrapTemplateName

string

Display name of the clickwrap template

clickwrapTemplateVersion

integer

Effective major version of the template

clickwrapTemplateVersionMinor

integer

Effective minor version of the template