Investor Preferences

List the investor preferences that apply to an investor

GET/investors/{investor_id}/investor-preferences
investor-preferences:readlist_investor_investor_preferencesRead-only

Lists the preferences that apply to one investor, newest first, and returns one page. One applies when it has no classifications or shares one with the investor. Each row adds the investor's own implementation_id, implementation_completed and user_state. filter[enabled] keeps enabled or disabled ones; filter[forced]=true keeps enabled forced ones the investor has neither saved nor completed. Never gives the investor a copy of a form. An unknown investor returns 404. Changes nothing.

Path parameters

  • investor_idstring (uuid)Required#

    The investor's id, a uuid. An unknown investor, or one outside the token's organisation and its client organisations, returns 404.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

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

  • sortstring#

    Comma-separated fields to sort by: created_at. Prefix a field with - for descending. Defaults to -created_at.

  • filter[enabled]boolean#

    Only enabled (true) or disabled (false) preferences.

  • filter[forced]boolean#

    true keeps the enabled preferences with enforcement forced that the investor has neither saved nor completed; false keeps the rest.

Responses

200

One page of the preferences that apply to the investor.

InvestorPreferenceLookup[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "form_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "state": "enabled",
      "enforcement_type": "none",
      "editable": true,
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00",
      "implementation_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "implementation_completed": true,
      "user_state": {
        "dismissed": true,
        "saved": true
      }
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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/investors/{investor_id}/investor-preferences\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"