aVenture APIPerson Batch

Batch person detail enrichment

View as Markdown

Enrich multiple people by id or slug with optional url, association, and address. 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.

Authentication

X-Client-Secretstring

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

Query parameters

includePrivatebooleanOptional

Include private fields. Defaults to private for admin API key or ROLE_ADMIN callers; client-secret/client-read callers stay public.

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
idlist of stringsOptional
Person UUID values
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
sluglist of stringsOptional
Person slug values
urllist of stringsOptional
Person URL values

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