Get Turnstile Config

GET/web/v1/system/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/turnstile WEB

Retrieves the Cloudflare Turnstile configuration for the specified institution.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token

Request Parameters

Path Parameters

Name	Type	Required	In	Description
workspaceId	string	Required	path	Workspace business ID
institutionBizId	string	Required	path	Institution business ID

Success Response

Success 200

{
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "id": 1,
    "institutionBizId": "INST_ACME_001",
    "turnstileSiteKey": "0x4AAAAAAABkMYinukE8nMDQ",
    "turnstileSecretKey": "****nMDQ",
    "enabled": true,
    "remark": "Production turnstile",
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Response Fields

Field	Type	Description
id	number	Internal record ID
institutionBizId	string	Institution business ID
turnstileSiteKey	string	Cloudflare Turnstile site key (full value)
turnstileSecretKey	string	Masked secret key (only last 4 characters visible, e.g. ****nMDQ)
enabled	boolean	Whether Turnstile verification is currently enabled
remark	string|null	Configuration remark
createdAt	string	ISO 8601 creation timestamp
updatedAt	string	ISO 8601 last update timestamp

Error Responses

Code	Description
4010	Unauthorized (invalid or missing JWT token)
4040	Institution or turnstile configuration not found

Notes

• The turnstileSecretKey is masked in the response for security purposes. Only the last 4 characters are visible (format: ****xxxx).
• The enabled field indicates whether Turnstile is actively enforced. Use the Enable Turnstile / Disable Turnstile endpoints to toggle.