Settings

Get the document settings

GET/settings/documents
documents:readget_document_settingsRead-only

Returns the organisation-wide document settings: hidden folders and tabs, default countersigning, signature behaviour and which audiences see watermarked documents. Settings on a single document or folder are on that document or folder.

Responses

200

The document settings.

DocumentSettings
{
  "data": {
    "folder_visibility": {
      "hide_deal_information": true,
      "hide_pre_investment": true,
      "hide_portfolio_tab_for_investors": true,
      "hide_portfolio_tab_for_internal_users": true
    },
    "document_countering_enabled": true,
    "signatures": {
      "allow_editing_investor_name": true,
      "autofill_investor_name": true,
      "replace_certificate_qr_code_with_hash": true
    },
    "watermarking": {
      "investors": true,
      "internal_users": true,
      "entrepreneurs": true,
      "advisors": true
    }
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/settings/documents\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"