GET
List investors

Authorizations

Authorization
string
header
required

Staff access token. Sent as Authorization: Bearer <token>, or — when that header is absent — read from the accessToken cookie, which is how the admin app authenticates. Tokens carry a tokenVersion; logout and password reset bump it, revoking every outstanding token for that account.

Query Parameters

status
string

Exact match on investorStatus. Comma-separate to match any of several values.

registrationType
string

Exact match on registration type. Comma-separate to match any of several values.

sortBy
string

Field to sort by. Takes effect only alongside sortOrder, and then overrides sort.

sortOrder
enum<string>

Direction for sortBy. Ignored unless sortBy is also given.

Available options:
asc,
desc
page
integer

1-based page number. Defaults to 1.

Required range: x <= 9007199254740991
limit
integer

Records per page, 1-100. Defaults to 20.

Required range: x <= 100
sort
string

Field names separated by spaces (or commas, which are normalized to spaces), - prefix for descending. Defaults to -createdAt.

Pattern: ^-?[A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*(?:[\s,]+-?[A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)*$

Case-insensitive substring matched against legalName, externalId, email.

fields
string

Comma-separated subset of legalName, externalId, email to match search against. Names outside that list are ignored, and an empty intersection falls back to all of them.

Response

A page of investors.

Standard success envelope. The endpoint payload is in data.

data
object
required
message
string
required
Example:

"Success"

meta
object
required
statusCode
integer
required
Example:

200

success
boolean
required
Example:

true