aVenture APIEntities

Search companies and other entities (POST)

View as Markdown
Run keyword, semantic, or explicit structured entity filtering with an EntityFilter JSON body. entityName is an exact normalized brand/legal-name filter; textSearch is keyword/full-text search. For a plain-English or multi-constraint company request, use 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

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.

Request

This endpoint expects an object.
acceleratorBrandlist of stringsOptional
Accelerator brand or operator name.
acceleratorCohortlist of stringsOptional
Accelerator batch or cohort label.
acceleratorNamelist of stringsOptional
Specific accelerator program name.
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.

employeeCountRangelist of objectsOptional

Inclusive reported employee-count ranges, in employees.

entityIdlist of stringsOptional
Restrict results to specific entity IDs.
entityNamelist of stringsOptional
Exact normalized match against entity brand or legal names.
featuredboolean or nullOptional
Filter by featured status.
fundraiseActivityobjectOptional
Fundraise activity
hasFundraisingboolean or nullOptional
Filter to entities with fundraise activity.
headquartersCitylist of stringsOptional
Headquarters city values.
headquartersCountrylist of stringsOptional
Headquarters country values.
headquartersStatelist of stringsOptional
Headquarters state or region values.
industrylist of stringsOptional
Industry classification values.
letterstring or nullOptional
First letter of the display name.
locationlist of stringsOptional
Geographic classification values.
logoOptionobjectOptional
Logo sort priority.
mainProductlist of stringsOptional
Main product classification values.
operatingStatuslist of stringsOptional
Operating status values.
portfolioHeadquartersCitylist of stringsOptional

Portfolio-company headquarters city values.

portfolioHeadquartersCountrylist of stringsOptional

Portfolio-company headquarters country values.

portfolioHeadquartersStatelist of stringsOptional

Portfolio-company headquarters state or region values.

qualityGateenumOptional

Named server-owned list quality gate.

semanticQuerystring or nullOptional
Semantic entity search phrase.
sluglist of stringsOptional
Restrict results to entity slugs.
stagelist of stringsOptional
Investment stage classification values.
suppressNonOperatingboolean or nullOptional
Suppress entities with terminal operating status.
suppressZeroTotalRaisedboolean or nullOptional
Suppress entities whose total raised is zero.
taglist of stringsOptional
General classification tag values.
textSearchstring or nullOptional

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

typeCustomerlist of stringsOptional

Customer-type classification values.

typeModellist of stringsOptional

Business-model classification values.

typeOwnershiplist of stringsOptional

Ownership-model classification values.

typeRecordlist of enumsOptional

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

typeRevenuelist of stringsOptional

Revenue-model classification values.

typeTechnologyUsedlist of stringsOptional

Technology-used classification values.

urlstring or nullOptional
Current URL to match by normalized host and path.
urlDomainstring or nullOptional

Current root domain to match when urlMatchMode=domain.

urlMatchModeenumOptional

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

urlTypeenum or nullOptional
Restrict URL matching to one URL type.
yearFoundedRangelist of objectsOptional

Inclusive founding-year ranges, in calendar years.

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
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error