aVenture APIEntities

Look up one entity

View as Markdown

Resolves one entity by slug, URL or candidate signals with the existing detail qualifiers and visibility rules. Use the UUID item route for an id; any id query parameter is rejected. Changed slugs retain their canonical redirect.

Authentication

X-Client-Secretstring

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

Query parameters

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters
Exact entity slug.
companySlugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Provider slug for Product/Service slug lookup. Historically named companySlug; providerTypeRecord can narrow this to Company, Nonprofit, or Government routes.

providerTypeRecordstringOptional

Concrete provider type qualifier for a Product/Service provider route; group-only Organization is invalid. Use with companySlug when resolving /companies/{slug}/products-services/{product}, /non-profits/{slug}/products-services/{product}, or /government/{slug}/products-services/{product}.

urlstringOptional

Entity URL matched by host and path unless urlMatchMode=domain.

urlTypestringOptional

URL type qualifier. List the accepted tokens with GET /v1/entities/urls/types (CLI: entities urls types list).

urlMatchModestringOptional

URL matching mode: hostPath (default for url) or domain. Omit when urlDomain is supplied; urlDomain selects domain mode automatically.

typeRecordstringOptional

Concrete entity type qualifier; group-only Organization is invalid. List the accepted concrete tokens and their aliases with GET /v1/entities/types (CLI: entities type-record types list).

namestringOptional
Primary entity name candidate.
nameBrandstringOptional
Brand name candidate.
nameLegalstringOptional
Legal name candidate.
locationstringOptional

Location candidate: city, state, or country.

urlDomainstringOptional
Website domain candidate without protocol or path.
permitMonogrambooleanOptional
Allow generated monogram logo fallback.
includePrivatebooleanOptional

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

Response

OK
coreobject
Core entity identity, naming, status, image, and source metadata.
enrichmentobject

Entity enrichment: addresses, classification, funding summary, text, and URL links.

fundraiseRoundlist of objects
Fundraise rounds associated with this entity.
newsArticlelist of objects
News articles associated with this entity.
personlist of objects
People associated with this entity.
relationshiplist of objects
Entity relationships.
researchobject

Combined research disclosure: governed detail rows, snippets, and accelerator participation.

sitemapobject

Sub-route eligibility computed once at the persistence boundary.

uniqueIdlist of objects
External registry identifiers associated with this entity.
publicUrlstring or nullOptional
Absolute canonical public URL when this detail has a renderable public route.

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