List or search companies and other entities (GET)

View as Markdown
Browse paginated entity records or apply explicit query filters. entityName is an exact normalized brand/legal-name filter; textSearch is keyword/full-text search. Organization expands to the canonical organization type group. For a plain-English or multi-constraint company request, use the search entities command (POST /v1/entities/natural-search) instead. Set semanticQuery for semantic nearest-neighbor ranking over stored content embeddings; semanticQuery uses the live priority embeddings tier and returns semanticMatch evidence. countOnly is unsupported when semanticQuery is present; count-only pages have no content, so read totalElements rather than empty. Default public visibility can filter hidden/off-sitemap records and does not prove create safety; use duplicate-check before writes that need identity review.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

entityIdlist of stringsOptional
Restrict results to specific entity IDs.
sluglist of stringsOptional
Restrict results to entity slugs.
entityNamelist of stringsOptional
Exact normalized match against entity brand or legal names.
typeRecordlist of enumsOptional

Entity type filter. Organization expands to Company, Investment Firm, Nonprofit, and Government; omit to include every entity type.

industrylist of stringsOptional
Industry classification values.
locationlist of stringsOptional
Geographic classification values.
taglist of stringsOptional
General classification tag values.
mainProductlist of stringsOptional
Main product classification values.
typeTechnologyUsedlist of stringsOptional

Technology-used classification values.

typeModellist of stringsOptional

Business-model classification values.

typeOwnershiplist of stringsOptional

Ownership-model classification values.

typeCustomerlist of stringsOptional

Customer-type classification values.

typeRevenuelist of stringsOptional

Revenue-model classification values.

acceleratorBrandlist of stringsOptional
Accelerator brand or operator name.
acceleratorNamelist of stringsOptional
Specific accelerator program name.
acceleratorCohortlist of stringsOptional
Accelerator batch or cohort label.
acceleratorStatuslist of stringsOptional
Accelerator participation status.
affinitylist of stringsOptional

Affinity provider organization names accepted by the companies list filter. Affinity rows are member -> provider; use provider names here, not member names.

headquartersCountrylist of stringsOptional
Headquarters country values.
headquartersStatelist of stringsOptional
Headquarters state or region values.
headquartersCitylist of stringsOptional
Headquarters city values.
stagelist of stringsOptional
Investment stage classification values.
yearFoundedRangelist of objectsOptional

Inclusive founding-year ranges, in calendar years.

employeeCountRangelist of objectsOptional

Inclusive reported employee-count ranges, in employees.

operatingStatuslist of stringsOptional
Operating status values.
createdAtRange.mindatetimeOptional
Inclusive earliest timestamp.
createdAtRange.maxdatetimeOptional
Inclusive latest timestamp.
updatedAtRange.mindatetimeOptional
Inclusive earliest timestamp.
updatedAtRange.maxdatetimeOptional
Inclusive latest timestamp.
letterstringOptional
First letter of the display name.
isHiddenbooleanOptional
Privileged filter by hidden status.
showOnSitemapbooleanOptional
Privileged filter by public sitemap inclusion.
hasFundraisingbooleanOptional
Filter to entities with fundraise activity.
featuredbooleanOptional
Filter by featured status.
suppressZeroTotalRaisedbooleanOptional
Suppress entities whose total raised is zero.
suppressNonOperatingbooleanOptional
Suppress entities with terminal operating status.
qualityGateenumOptional

Named server-owned list quality gate.

Allowed values:
urlstringOptional
Current URL to match by normalized host and path.
urlDomainstringOptional

Current root domain to match when urlMatchMode=domain.

urlTypeenumOptional
Restrict URL matching to one URL type.
urlMatchModeenumOptional

URL matching mode: hostPath uses host and path; domain uses the root domain.

Allowed values:
portfolioHeadquartersCountrylist of stringsOptional

Portfolio-company headquarters country values.

portfolioHeadquartersStatelist of stringsOptional

Portfolio-company headquarters state or region values.

portfolioHeadquartersCitylist of stringsOptional

Portfolio-company headquarters city values.

fundraiseActivity.roundlist of stringsOptional
Fundraise round labels, such as Seed or Series A.
fundraiseActivity.amountRaisedRangelist of objectsOptional

Per-round amount-raised ranges in USD. Use plain JSON numbers.

fundraiseActivity.amountInvestedRangelist of objectsOptional

Investor-level amount-invested ranges in the transaction currency. Use plain JSON numbers.

fundraiseActivity.totalRaisedRangelist of objectsOptional

Total-raised ranges across all rounds in USD. Use plain JSON numbers.

fundraiseActivity.valuationRangelist of objectsOptional

Post-money valuation ranges in USD.

fundraiseActivity.lastRoundYearRangelist of objectsOptional

Last-round-year ranges for each entity’s most recent fundraise round.

fundraiseActivity.investedCompanyNamelist of stringsOptional

Portfolio company names. Exact, case-sensitive match on the portfolio company’s brand or legal name; restricts returned entities to investors in those companies.

fundraiseActivity.investorActivity.totalInvestmentRangelist of objectsOptional

Distinct fundraise-deal count ranges for an investor, with inclusive integer bounds.

fundraiseActivity.investorActivity.totalAmountInvestedUsdRangelist of objectsOptional

Total USD amount-invested ranges with inclusive bounds.

fundraiseActivity.investorActivity.averageAmountInvestedUsdRangelist of objectsOptional

Average USD amount-invested ranges with inclusive bounds.

fundraiseActivity.investorActivity.largestAmountInvestedUsdRangelist of objectsOptional

Largest USD amount-invested ranges with inclusive bounds.

fundraiseActivity.investorActivity.smallestAmountInvestedUsdRangelist of objectsOptional

Smallest USD amount-invested ranges with inclusive bounds.

textSearchstringOptional

Non-blank keyword/full-text search term. Use natural-search for plain-English or multi-constraint company requests.

semanticQuerystringOptional
Semantic entity search phrase.
countOnlybooleanOptional
Return only the matching entity count in totalElements. Content is empty by design, so the page empty flag describes content, not whether matches exist. Unsupported with semanticQuery.
permitMonogrambooleanOptional
Allow generated monogram logos in results.
includePrivatebooleanOptional

Privileged admin readback scope. Includes hidden or off-sitemap entities. Defaults to private for admin API key or ROLE_ADMIN callers; client-secret/client-read callers stay public.

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 20
The size of the page to be returned
sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error