Skip to navigation
aVenture APICompaniesEntities

Look Up Which Company Each Identifier Matches

View as Markdown

Resolves each queried id, slug, and current joined URL to exactly one outcome row that echoes the raw input: MATCHED with full detail, AMBIGUOUS with candidate ids when a URL is currently owned by more than one entity, or MISSING. Unlike the batch detail read, no input is silently dropped and every row maps back to its source identifier. URL matching is host+path exact: scheme and a leading www are ignored, but distinct paths stay distinct (stripe.com does not match stripe.com/payments). A signed-in user’s read charges one view per distinct returned record against the monthly entity or person view allowance; a repeat read of the same record in the month is free, and an exhausted cap answers 429 with Retry-After.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
entityIdlist of stringsOptional
Entity UUID values
permitMonogramboolean or nullOptionalDefaults to true
Permit monogram fallbacks
sluglist of stringsOptional
Entity slug values
urllist of stringsOptional
Current joined entity URL values

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
candidateEntityIdlist of strings

Entity ids that all currently own the queried URL when status is AMBIGUOUS; empty otherwise. Re-query a single id to disambiguate.

inputstring

Raw identifier exactly as queried (UUID string, slug, or URL).

inputTypeenum
Which identifier kind this row was queried by.
Allowed values:
statusenum
Resolution outcome for this input.
Allowed values:
detailobject or nullOptional

Full entity detail when status is MATCHED; absent otherwise.

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