List people (POST)

POST

https://api.aventure.vc/v1/people

POST

/v1/people

$ curl -X POST "https://api.aventure.vc/v1/people?includePrivate=false" \
>      -H "X-Client-Secret: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "content": [
3     {
4       "id": "string",
5       "image": {
6         "isMonogram": true,
7         "picture": "string"
8       },
9       "nameAlias": [
10         {
11           "name": "Bun",
12           "displayable": true,
13           "type": "nickname"
14         }
15       ],
16       "nameFull": "string",
17       "slug": "aventure-vc",
18       "source": {
19         "changedAt": "2024-01-15T09:30:00Z",
20         "dataSourceUpdatedAt": "2024-01-15T09:30:00Z",
21         "detail": "string",
22         "kind": "string",
23         "pendingApproval": 1,
24         "sourceId": "string",
25         "status": "string"
26       },
27       "text": {
28         "expanded": "Canonical expanded summary for grouped text assertions.",
29         "generatedDescription": "Acme AI builds AI copilots for growth teams.",
30         "short": "Canonical short summary"
31       },
32       "createdAt": "2024-01-15T09:30:00Z",
33       "gender": "string",
34       "lastModifiedAt": "2024-01-15T09:30:00Z",
35       "nameFirst": "string",
36       "nameLast": "string",
37       "nameMiddle": "string",
38       "nickname": "string",
39       "publicId": "pV1StGXR8Z5ab",
40       "semanticMatch": {
41         "computedAt": "2024-01-15T09:30:00Z",
42         "cosineDistance": 1.1,
43         "cosineScore": 1.1,
44         "modelVersion": "string",
45         "rank": 1,
46         "sourceHash": "string",
47         "sourceId": "string",
48         "sourceJson": "string",
49         "sourceText": "string",
50         "sourceType": "entity"
51       },
52       "suffix": "string",
53       "updatedAt": "2024-01-15T09:30:00Z"
54     }
55   ],
56   "empty": true,
57   "first": true,
58   "last": true,
59   "number": 1,
60   "numberOfElements": 1,
61   "pageable": {
62     "offset": 1,
63     "pageNumber": 1,
64     "pageSize": 1,
65     "paged": true,
66     "sort": {
67       "empty": true,
68       "sorted": true,
69       "unsorted": true
70     },
71     "unpaged": true
72   },
73   "size": 1,
74   "sort": {
75     "empty": true,
76     "sorted": true,
77     "unsorted": true
78   },
79   "totalElements": 1,
80   "totalPages": 1
81 }

Returns a paginated people list matching a filter request body. semanticQuery uses the live priority embeddings tier and returns semanticMatch evidence.

Authentication

X-Client-Secretstring

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

Query parameters

countOnlybooleanOptional

When true, return only the page total in the body and skip the content payload.

hasImageFirstbooleanOptional

When true, sort people who have a photo before those who do not.

permitMonogrambooleanOptional

When false, monogram fallback logos are stripped from the response. Defaults to true.

includePrivatebooleanOptional

Privileged read scope for admin callers. Bypasses the public visibility filter so hidden, unverified, and not-yet-published records are returned instead of being silently dropped. 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.

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

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