Branding

List the semantic keywords

GET/branding/semantics
branding:readget_branding_semanticsRead-only

Lists every live semantic keyword, the platform's names for things such as deals and investors, with the token organisation's override applied: singular_label, plural_label and indefinite_modifier, and is_overridden. Not paginated. Each organisation sees only its own overrides. Needs only branding:read, not super admin. Changes nothing. Use PUT /branding/semantics to set them.

Responses

200

The semantic keywords.

Semantic[]
{
  "data": [
    {
      "id": 1,
      "name": "deal",
      "singular_label": "opportunity",
      "plural_label": "opportunities",
      "indefinite_modifier": "an",
      "is_overridden": true
    },
    {
      "id": 2,
      "name": "investor",
      "singular_label": "investor",
      "plural_label": "investors",
      "indefinite_modifier": "an",
      "is_overridden": false
    }
  ]
}
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/branding/semantics\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"