Investor Preferences

Get an investor preference

GET/investor-preferences/{id}
investor-preferences:readget_investor_preferenceRead-only

Returns one preference. An unknown, malformed or deleted id returns 404. Use GET /investor-preferences to list them and GET /investor-preferences/{id}/classifications for the classifications it applies to. Changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The preference.

InvestorPreference
{
  "data": {
    "id": "4f7c1d2e-8a3b-4c5d-9e6f-0a1b2c3d4e5f",
    "name": "Quarterly updates",
    "form_id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "state": "enabled",
    "enforcement_type": "popup",
    "editable": true,
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:30:00Z"
  }
}
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
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/investor-preferences/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"