Investor Preferences

List investor preferences

GET/investor-preferences
investor-preferences:readlist_investor_preferencesRead-only

Lists every investor preference form in the platform, newest first, and returns one page. Preferences are not specific to your organisation. filter[state], filter[enforcement_type] and filter[editable] narrow the list and filter[q] searches the name. Use GET /investor-preferences/{id} for one. Changes nothing.

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, updated_at or name. Prefix a field with - for descending. Defaults to -created_at.

  • filter[state]string#

    Only preferences in this state: enabled or disabled. Takes the in and not_in operators.

    One of: enabled, disabled
  • filter[enforcement_type]string#

    Only preferences with this enforcement type: none, popup or forced.

    One of: none, popup, forced
  • filter[editable]boolean#

    Only preferences investors can (true) or cannot (false) change after answering.

  • filter[q]string#

    Preferences whose name contains this text, ignoring case.

Responses

200

One page of investor preferences.

InvestorPreference[]
{
  "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"
    }
  ],
  "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/investor-preferences\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"