Skip to navigation
aVenture APIPeoplePeople

Look Up People in Bulk by ID or Slug

View as Markdown

Returns several people by id or slug, with their URLs, roles at entities, and addresses, each of which can be left out. 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. 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.
hasImageFirstbooleanOptionalDefaults to false
Sort results by image presence
includeAddressbooleanOptionalDefaults to true
Include address values
includeAssociationbooleanOptionalDefaults to true
Include association values
includeUrlbooleanOptionalDefaults to true
Include URL links
maxAssociationsintegerOptionalDefaults to 40
Max association values per person
permitMonogrambooleanOptionalDefaults to true
Permit monogram fallbacks
personIdlist of stringsOptional
Person UUID values
sluglist of stringsOptional
Person slug values
urllist of stringsOptional
Person URL values

Response headers

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

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