List entity people associations

GET

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

GET

/v1/entities/:entityId/people

$ curl https://api.aventure.vc/v1/entities/entityId/people \
>      -H "X-Client-Secret: <apiKey>"

1 {
2   "content": [
3     {
4       "createdAt": "2024-01-15T09:30:00Z",
5       "gender": "string",
6       "id": "string",
7       "image": {
8         "isMonogram": true,
9         "picture": "string"
10       },
11       "lastModifiedAt": "2024-01-15T09:30:00Z",
12       "nameAlias": [
13         {
14           "displayable": true,
15           "name": "Bun",
16           "type": "nickname"
17         }
18       ],
19       "nameFirst": "string",
20       "nameFull": "string",
21       "nameLast": "string",
22       "nameMiddle": "string",
23       "nickname": "string",
24       "publicId": "pV1StGXR8Z5ab",
25       "semanticMatch": {
26         "computedAt": "2024-01-15T09:30:00Z",
27         "cosineDistance": 1.1,
28         "cosineScore": 1.1,
29         "modelVersion": "string",
30         "rank": 1,
31         "sourceHash": "string",
32         "sourceId": "string",
33         "sourceJson": "string",
34         "sourceText": "string",
35         "sourceType": "entity"
36       },
37       "slug": "aventure-vc",
38       "source": {
39         "changedAt": "2024-01-15T09:30:00Z",
40         "dataSourceUpdatedAt": "2024-01-15T09:30:00Z",
41         "detail": "string",
42         "kind": "string",
43         "pendingApproval": 1,
44         "sourceId": "string",
45         "status": "string"
46       },
47       "suffix": "string",
48       "text": {
49         "expanded": "Canonical expanded summary for grouped text assertions.",
50         "generatedDescription": "Acme AI builds AI copilots for growth teams.",
51         "short": "Canonical short summary"
52       },
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 people associated with one entity. Public and client-secret reads exclude hidden entities; trusted admin credentials include them for write readback.

Authentication

X-Client-Secretstring

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity UUID

Query parameters

idstringOptionalformat: "uuid"

Entity unique identifier (UUID) — at least one of id or slug required

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Entity URL-friendly identifier — at least one of id or slug required

searchstringOptional

Search term filter

rolestringOptional

Association role filter

isCurrentbooleanOptional

Current association filter

includeUrlbooleanOptional

Include person URL records

includeAddressbooleanOptional

Include person address records

asstringOptional

Projection: core (default) returns person identity only and omits association fields. association returns PersonDetail rows with the matching join under association[]; read title and period fields from association[].titleName, association[].startDate, and association[].endDate. Person sitemap visibility is owned by people detail/status reads, not this list projection.

Projection: `core` (default) returns person identity only and omits association fields. `association` returns PersonDetail rows with the matching join under `association[]`; read title and period fields from `association[].titleName`, `association[].startDate`, and `association[].endDate`. Person sitemap visibility is owned by people detail/status reads, not this list projection.

personSlugstringOptional

Person slug fallback for entity-keyed writes

countOnlybooleanOptional

Return count metadata without full content

permitMonogrambooleanOptional

Permit generated monogram fallback

includePrivatebooleanOptional

Privileged read scope. Includes associations on hidden entities. Defaults to private visibility for admin API key or ROLE_ADMIN callers; explicit true requires that authority.

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 40

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.

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

404

Not Found Error

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error