List people similar to one person

GET

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

GET

/v1/people/detail/similar

$ curl -G https://api.aventure.vc/v1/people/detail/similar \
>      -H "X-Client-Secret: <apiKey>" \
>      -d id=04e2bf9c-a100-72ad-83ff-ba69c647b30b \
>      -d slug=jane-doe

1 {
2   "content": [
3     {
4       "person": {
5         "id": "string",
6         "image": {
7           "isMonogram": true,
8           "picture": "string"
9         },
10         "nameAlias": [
11           {
12             "name": "Bun",
13             "displayable": true,
14             "type": "nickname"
15           }
16         ],
17         "nameFull": "string",
18         "slug": "aventure-vc",
19         "source": {
20           "changedAt": "2024-01-15T09:30:00Z",
21           "dataSourceUpdatedAt": "2024-01-15T09:30:00Z",
22           "detail": "string",
23           "kind": "string",
24           "pendingApproval": 1,
25           "sourceId": "string",
26           "status": "string"
27         },
28         "text": {
29           "expanded": "Canonical expanded summary for grouped text assertions.",
30           "generatedDescription": "Acme AI builds AI copilots for growth teams.",
31           "short": "Canonical short summary"
32         },
33         "createdAt": "2024-01-15T09:30:00Z",
34         "gender": "string",
35         "lastModifiedAt": "2024-01-15T09:30:00Z",
36         "nameFirst": "string",
37         "nameLast": "string",
38         "nameMiddle": "string",
39         "nickname": "string",
40         "publicId": "pV1StGXR8Z5ab",
41         "semanticMatch": {
42           "computedAt": "2024-01-15T09:30:00Z",
43           "cosineDistance": 1.1,
44           "cosineScore": 1.1,
45           "modelVersion": "string",
46           "rank": 1,
47           "sourceHash": "string",
48           "sourceId": "string",
49           "sourceJson": "string",
50           "sourceText": "string",
51           "sourceType": "entity"
52         },
53         "suffix": "string",
54         "updatedAt": "2024-01-15T09:30:00Z"
55       },
56       "similarity": {
57         "origin": "precomputed",
58         "rank": 1,
59         "compositeScore": 1.1,
60         "cosineScore": 1.1,
61         "matchedSectionWeight": 1.1,
62         "sharedSectionCount": 1
63       },
64       "currentRole": {
65         "associationId": 1,
66         "entityAddress": [
67           {
68             "address": 456,
69             "addressLine1": "string",
70             "addressLine2": "string",
71             "association": [
72               {
73                 "id": 123,
74                 "isCurrent": true,
75                 "endDate": "2023-01-15",
76                 "role": "domicile",
77                 "startDate": "2023-01-15"
78               }
79             ],
80             "city": {
81               "name": "Boston",
82               "id": 1
83             },
84             "country": {
85               "name": "United States",
86               "countryCodeChar2": "US",
87               "countryCodeChar3": "USA",
88               "id": 1,
89               "unRegion": "string",
90               "unSubregion": "string"
91             },
92             "countryAbbrev": "string",
93             "createdAt": "2024-01-15T09:30:00Z",
94             "fullAddress": "123 Main St, Boston, MA 02110, USA",
95             "id": 123,
96             "latitude": 1.1,
97             "longitude": 1.1,
98             "postalCode": "string",
99             "state": {
100               "name": "Massachusetts",
101               "id": 1,
102               "stateAbbrev": "MA"
103             },
104             "stateAbbrev": "string",
105             "street": "string",
106             "updatedAt": "2024-01-15T09:30:00Z",
107             "isCurrent": true,
108             "isHq": true,
109             "isPrimary": true
110           }
111         ],
112         "entityId": "string",
113         "entityLogo": {
114           "isMonogram": true,
115           "logo": "string",
116           "logoSquare": "string"
117         },
118         "entitySlug": "aventure-vc",
119         "entityUrlLink": [
120           {
121             "url": "https://example.com",
122             "urlType": "website",
123             "crawlCdnProvider": "cloudflare",
124             "crawlRenderMode": "static",
125             "createdAt": "2024-01-15T09:30:00Z",
126             "id": 1,
127             "isCurrent": true,
128             "isPrimary": true,
129             "owner": {
130               "entityId": "string",
131               "personId": "string"
132             },
133             "sourceId": "string",
134             "status": "string",
135             "statusChecked": "2024-01-15T09:30:00Z",
136             "updatedAt": "2024-01-15T09:30:00Z"
137           }
138         ],
139         "personAddress": [
140           {
141             "address": 456,
142             "addressLine1": "string",
143             "addressLine2": "string",
144             "association": [
145               {
146                 "id": 123,
147                 "isCurrent": true,
148                 "endDate": "2023-01-15",
149                 "role": "domicile",
150                 "startDate": "2023-01-15"
151               }
152             ],
153             "city": {
154               "name": "Boston",
155               "id": 1
156             },
157             "country": {
158               "name": "United States",
159               "countryCodeChar2": "US",
160               "countryCodeChar3": "USA",
161               "id": 1,
162               "unRegion": "string",
163               "unSubregion": "string"
164             },
165             "countryAbbrev": "string",
166             "createdAt": "2024-01-15T09:30:00Z",
167             "fullAddress": "123 Main St, Boston, MA 02110, USA",
168             "id": 123,
169             "latitude": 1.1,
170             "longitude": 1.1,
171             "postalCode": "string",
172             "state": {
173               "name": "Massachusetts",
174               "id": 1,
175               "stateAbbrev": "MA"
176             },
177             "stateAbbrev": "string",
178             "street": "string",
179             "updatedAt": "2024-01-15T09:30:00Z",
180             "isCurrent": true,
181             "isHq": true,
182             "isPrimary": true
183           }
184         ],
185         "personId": "string",
186         "personImage": {
187           "isMonogram": true,
188           "picture": "string"
189         },
190         "personName": "string",
191         "personSlug": "aventure-vc",
192         "personUrlLink": [
193           {
194             "url": "https://example.com",
195             "urlType": "website",
196             "crawlCdnProvider": "cloudflare",
197             "crawlRenderMode": "static",
198             "createdAt": "2024-01-15T09:30:00Z",
199             "id": 1,
200             "isCurrent": true,
201             "isPrimary": true,
202             "owner": {
203               "entityId": "string",
204               "personId": "string"
205             },
206             "sourceId": "string",
207             "status": "string",
208             "statusChecked": "2024-01-15T09:30:00Z",
209             "updatedAt": "2024-01-15T09:30:00Z"
210           }
211         ],
212         "createdAt": "2024-01-15T09:30:00Z",
213         "creator": "string",
214         "endDate": "2024-01-15T09:30:00Z",
215         "entityName": "string",
216         "entityOperatingStatus": "string",
217         "entityType": "Company",
218         "isCurrent": true,
219         "score": 1,
220         "startDate": "2024-01-15T09:30:00Z",
221         "titleFunction": "string",
222         "titleId": 1,
223         "titleLevel": "string",
224         "titleName": "string",
225         "updatedAt": "2024-01-15T09:30:00Z"
226       }
227     }
228   ],
229   "empty": true,
230   "first": true,
231   "last": true,
232   "number": 1,
233   "numberOfElements": 1,
234   "pageable": {
235     "offset": 1,
236     "pageNumber": 1,
237     "pageSize": 1,
238     "paged": true,
239     "sort": {
240       "empty": true,
241       "sorted": true,
242       "unsorted": true
243     },
244     "unpaged": true
245   },
246   "size": 1,
247   "sort": {
248     "empty": true,
249     "sorted": true,
250     "unsorted": true
251   },
252   "totalElements": 1,
253   "totalPages": 1
254 }

Returns similar people by id or slug. Results include the person row and per-row similarity provenance; load full detail through the person detail endpoints. Results are ordered by similarity score (highest first). This endpoint does not support custom sorting.

Authentication

X-Client-Secretstring

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

Query parameters

idstringOptionalformat: "uuid"

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

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

Person URL-friendly identifier (slug) — at least one of id or slug required

permitMonogrambooleanOptional

Permit monogram fallback

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 10

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

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error

Authentication

Headers

Query parameters

Response

Errors