Skip to navigation

Look Up Companies in Bulk by ID, Slug, or URL

View as Markdown

Returns a page envelope of entity detail records by id, slug, and/or current joined URL. It accepts no company names; identify one by name with lookupRecord (POST /v1/lookup) and its name field, then batch the returned ids here. When page and size are omitted, the full deduplicated batch is returned in request order. Sort is not supported for this fixed-order batch response. For public reads totalElements counts the entities visible to the caller, so requested identifiers that do not resolve or fail the public visibility filter are excluded. For privileged reads totalElements counts the requested identifiers that resolved to an entity id, which can exceed the number of records returned when an id no longer exists. 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

Query parameters

pageintegerOptional

Zero-based page index (0..N); omit page and size for the full batch.

sizeintegerOptional

The size of the page to be returned; omit page and size for the full batch.

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
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