aVenture APIEntity Classifications

Get entity classification joins

View as Markdown

Returns joins grouped by bucket. The default view includes current rows; includeInactive=true adds historical rows and requires read auth. Callers with private-visibility authority (admin key or ROLE_ADMIN) also resolve hidden/private entities; includePrivate=true requires that authority, and a signed-in user without it is admitted for public entities but hidden entities 404.

Authentication

AuthorizationBearer

User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

OR
X-Client-Secretstring

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

Path parameters

entityIdstringRequiredformat: "uuid"
Canonical entity UUID

Query parameters

includeInactivebooleanOptionalDefaults to false

Include inactive/historical entity classification join rows; default false returns only current joins.

includePrivatebooleanOptional

Include private/hidden entity classification rows when the caller has private-visibility authority (admin key or ROLE_ADMIN). Without that authority hidden/private entities 404.

Response

OK
geoLocationExposurelist of objectsOptionalDefaults to []

Geographic markets where the entity earns revenue and serves customers (e.g. North America, EMEA, APAC). This is the sales/market footprint classification — NOT the HQ or office location. HQ and office locations belong on the address record (enrichment.address), not this bucket. A London-headquartered company selling globally should have North America and EMEA here, not United Kingdom.

industrylist of objectsOptionalDefaults to []
Industry filter values
mainProductlist of objectsOptionalDefaults to []
Main product filter values
standardizedClassificationlist of objectsOptionalDefaults to []

Standardized classification joins from res_classification_ref. Rows are join-existing-only and carry category/code metadata.

taglist of objectsOptionalDefaults to []
Tag filter values
typeCustomerlist of objectsOptionalDefaults to []
Type customer filter values
typeModellist of objectsOptionalDefaults to []
Type model filter values
typeOwnershiplist of objectsOptionalDefaults to []
Type ownership filter values
typeRevenuelist of objectsOptionalDefaults to []
Type revenue filter values
typeTechnologyUsedlist of objectsOptionalDefaults to []
Type technology used filter values

Errors

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