aVenture APIPerson Batch

Batch person list

View as Markdown

List people with Spring pageable request params and a typed PersonFilter body. Use projection=association to include bounded association detail rows while preserving the raw page body and cursor semantics.

Authentication

X-Client-Secretstring

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

Query parameters

cursorstringOptional

Cursor for pagination (format: timestamp::uuid)

maxAssociationsintegerOptional
Max association values per person
hasImageFirstbooleanOptional
Prioritize people with images before the default sort
permitMonogrambooleanOptional
Permit monogram fallback
includePrivatebooleanOptional

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

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 25
The size of the page to be returned
sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

projectionenumOptional

Batch projection mode. Omit or use core for Person rows; association returns PersonDetail rows with bounded associations.

Allowed values:

Request

This endpoint expects an object.
arrayFilterobjectOptional
Array and range filters
entityIdstring or nullOptionalformat: "uuid"
Associated entity UUID.
entitySlugstring or nullOptional
Associated entity slug.
firstNamestring or nullOptional
Person first name.
includeAddressboolean or nullOptional
Include addresses on each person
includeUrlboolean or nullOptional
Include URL links on each person
investorActivityobjectOptional
Aggregate investor activity filters.
isCurrentboolean or nullOptional
Filter current associations.
lastNamestring or nullOptional
Person last name.
letterstring or nullOptional

First-name initial.

rolestring or nullOptional
Associated entity role or title.
searchstring or nullOptional

Search keyword or phrase. Single characters valid; stop words rejected.

semanticQuerystring or nullOptional
Semantic person search phrase.
statusstring or nullOptional
Person workflow status.

Response

OK
PagePersonobject
OR
PagePersonDetailobject

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