Skip to main content
GET
Search filters and values

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 1h — 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.

Scopes

read:dimensions
oauth2

Grant the read:dimensions permission

read:dimensions
bearerAuth

Headers

API-Version
string<date>

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

Example:

"2026-10-22"

Query Parameters

scope
enum<string>
required

Required. One of: companies, investors, transactions, people, universities, gov_ngo, news, jobs, funds

Available options:
companies,
investors,
transactions,
people,
universities,
gov_ngo,
news,
jobs,
funds
Example:

"companies"

q
string
required

Search query (min 1 char). Filter labels and year heuristics are matched immediately; value lookup starts at 3 chars.

Minimum string length: 1
Example:

"fintech"

limit_per_row
integer<int32>
default:3

Max value matches per picker row (1-10, default 3)

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

3

limit
integer<int32>
default:20

Total result cap (1-50, default 20)

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

20

filter
string

Serialized filter expression already applied to the list. With include_counts=true, value-match counts are scoped to it, as in /reference/filters/{key}/values.

include_counts
boolean

Pass true to replace each value match's global entities_count with the count the filter's own values endpoint returns for this scope and filter. A match whose count can't be computed comes back without one.

Example:

true

Response

Search matches in tier-and-row order

data
(Filter value · object | Filter · object | Year · object)[]
required