Investors

List investors

GET/investors

Lists the investors in the token's organisation and its client organisations, newest first, and returns one page. filter[q] searches name and email, filter[status] takes active, pending, suspended, timeout, cooldown or deactivated, and include embeds data_capture, onboarding, invites or roles. The old search, status, created_from and created_to parameters still work until 2027-06-30, with Deprecation and Sunset headers. Includes load per investor; limit is at most 100 and nothing else caps them. Sends 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 or updated_at. Prefix a field with - for descending. Defaults to -created_at. The investor id is the final tiebreak.

  • includestring#

    Comma-separated related records to embed, from the operation's allowed list.

  • filter[q]string#

    Free-text search on name and email.

  • filter[status]string#

    Only investors in this state: active, pending, suspended, timeout, cooldown or deactivated. Takes [in] and [not_in] with a comma-separated list.

    One of: active, pending, suspended, timeout, cooldown, deactivated
  • filter[email]string#

    Only investors with this email on any live contact. Takes [in], [not_in] and [contains].

  • filter[classification_id]integer#

    Only investors holding this classification. Takes [in] and [not_in] with a comma-separated list of ids.

  • filter[created_at]string#

    Only investors created in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

  • filter[updated_at]string#

    Only investors changed in a range, written filter[updated_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

  • statusstringDeprecated#

    Use filter[status]. Still accepted until 2027-06-30, with a comma-separated list of states.

  • created_fromstring (date-time)Deprecated#

    Use filter[created_at][gte]. Still accepted until 2027-06-30.

  • created_tostring (date-time)Deprecated#

    Use filter[created_at][lte]. Still accepted until 2027-06-30.

Responses

200

One page of investors.

Investor[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "first_name": "string",
      "last_name": "string",
      "title": "string",
      "email": "string",
      "status": "active",
      "external_id": "string",
      "sso_id": "string",
      "key_contact_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "invite": {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "status": "invited",
        "expires_at": "2026-06-12T10:00:00+00:00"
      },
      "two_factor_enabled": true,
      "last_login": "2026-06-12T10:00:00+00:00",
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00",
      "data_capture": {},
      "onboarding": {
        "flow_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "flow_name": "string",
        "status": "pending",
        "completed_at": "2026-06-12T10:00:00+00:00"
      },
      "invites": [
        {}
      ],
      "roles": [
        {}
      ]
    }
  ],
  "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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"