Skip to main content
GET
List investors

Authorizations

Authorization
string
header
required

OAuth2 client-credentials flow against the Dealroom Auth0 tenant. Use the client_id / client_secret from a Programmatic API key. Tokens are valid for 24h — Swagger UI will reuse the same token across operations. Revoking or deactivating a key rejects it on the next request (within a ≤5-minute server-side cache window), not at token expiry.

Headers

API-Version
string<date>

Pin a Stripe-style date-based API version (YYYY-MM-DD). Omit to use the latest version (2026-09-01). A pinned version is supported for 30 days after it is superseded, after which it returns 400.

Example:

"2026-09-01"

Query Parameters

filter
string

Filter expression for investors using nested syntax.

Examples:

  • Single: total_invested[gte]:1000000
  • AND: and(total_invested[gte]:1000000,hq_location[eq]:233)
  • OR: or(investor_type[eq]:venture_capital,investor_type[eq]:private_equity)

Operators: eq, neq, gt, gte, lt, lte, in_any, nin_any in_all / nin_all are only available on repeated related-record filters. Legacy aliases: in → in_any, nin → nin_any (deprecated, prefer canonical names). Default ref: 'entity' (can be omitted for entity filters)

Example:

"and(total_invested[gte]:1000000,hq_location[eq]:233)"

limit
integer<int32>
default:25

Number of results to return (1-500, default 25)

Required range: 1 <= x <= 500
Example:

25

offset
integer<int32>
default:0

Number of results to skip before returning data. Combine with limit for offset-based pagination.

Required range: x >= 0
Example:

0

cursor
string

Opaque cursor token from a previous response's page.next_cursor or page.prev_cursor. Round-trip it as-is — do not decode or modify.

Example:

"eyJ2IjoxLCJkIjoibmV4dCJ9"

sort
string

Sort by one or more keys. Prefix with - for descending order; comma-separated for multi-key sorts.

Pattern: ^-?[\w,]+$
Example:

"-total_investments_count"

include_total
boolean

Pass true to include page.total (the matching record count) in the response. Default omits the total to avoid a count query.

Example:

true

currency
string

ISO 4217 currency code for monetary field conversion. Defaults to USD.

Example:

"EUR"

portfolio_count_tag
string

Pipe-separated tag IDs to count matching portfolio investments. Enables the portfolio_match_count sort key and match_count response field.

Pattern: ^\d+(\|\d+)*$
Example:

"22680"

portfolio_count_location
string

Pipe-separated location IDs to count matching portfolio investments. Enables the portfolio_match_count sort key and match_count response field.

Pattern: ^\d+(\|\d+)*$
Example:

"165"

Response

List of investors

data
object[]
required
page
object
required
currency
string
required