Skip to main content
GET
Search entities

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

q
string
required

Search term (minimum 1 character).

Minimum string length: 1
types
string

Comma-separated entity types to search (investor, person, company, university, gov_ngo). Defaults to every type the caller is permitted to read.

Example:

"company,investor"

limit
number
default:5

Maximum number of results per request (default 5, max 20)

Required range: 1 <= x <= 20

Response

Flat ranked results array, up to limit rows

data
object[]
required