List person entity associations

GET

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

GET

/v1/people/:personId/entities

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

1 {
2   "content": [
3     {
4       "associationId": 1,
5       "entityAddress": [
6         {
7           "address": 456,
8           "addressLine1": "string",
9           "addressLine2": "string",
10           "association": [
11             {
12               "id": 123,
13               "isCurrent": true,
14               "endDate": "2023-01-15",
15               "role": "domicile",
16               "startDate": "2023-01-15"
17             }
18           ],
19           "city": {
20             "name": "Boston",
21             "id": 1
22           },
23           "country": {
24             "name": "United States",
25             "countryCodeChar2": "US",
26             "countryCodeChar3": "USA",
27             "id": 1,
28             "unRegion": "string",
29             "unSubregion": "string"
30           },
31           "countryAbbrev": "string",
32           "createdAt": "2024-01-15T09:30:00Z",
33           "fullAddress": "123 Main St, Boston, MA 02110, USA",
34           "id": 123,
35           "latitude": 1.1,
36           "longitude": 1.1,
37           "postalCode": "string",
38           "state": {
39             "name": "Massachusetts",
40             "id": 1,
41             "stateAbbrev": "MA"
42           },
43           "stateAbbrev": "string",
44           "street": "string",
45           "updatedAt": "2024-01-15T09:30:00Z",
46           "isCurrent": true,
47           "isHq": true,
48           "isPrimary": true
49         }
50       ],
51       "entityId": "string",
52       "entityLogo": {
53         "isMonogram": true,
54         "logo": "string",
55         "logoSquare": "string"
56       },
57       "entitySlug": "aventure-vc",
58       "entityUrlLink": [
59         {
60           "url": "https://example.com",
61           "urlType": "website",
62           "crawlCdnProvider": "cloudflare",
63           "crawlRenderMode": "static",
64           "createdAt": "2024-01-15T09:30:00Z",
65           "id": 1,
66           "isCurrent": true,
67           "isPrimary": true,
68           "owner": {
69             "entityId": "string",
70             "personId": "string"
71           },
72           "sourceId": "string",
73           "status": "string",
74           "statusChecked": "2024-01-15T09:30:00Z",
75           "updatedAt": "2024-01-15T09:30:00Z"
76         }
77       ],
78       "personAddress": [
79         {
80           "address": 456,
81           "addressLine1": "string",
82           "addressLine2": "string",
83           "association": [
84             {
85               "id": 123,
86               "isCurrent": true,
87               "endDate": "2023-01-15",
88               "role": "domicile",
89               "startDate": "2023-01-15"
90             }
91           ],
92           "city": {
93             "name": "Boston",
94             "id": 1
95           },
96           "country": {
97             "name": "United States",
98             "countryCodeChar2": "US",
99             "countryCodeChar3": "USA",
100             "id": 1,
101             "unRegion": "string",
102             "unSubregion": "string"
103           },
104           "countryAbbrev": "string",
105           "createdAt": "2024-01-15T09:30:00Z",
106           "fullAddress": "123 Main St, Boston, MA 02110, USA",
107           "id": 123,
108           "latitude": 1.1,
109           "longitude": 1.1,
110           "postalCode": "string",
111           "state": {
112             "name": "Massachusetts",
113             "id": 1,
114             "stateAbbrev": "MA"
115           },
116           "stateAbbrev": "string",
117           "street": "string",
118           "updatedAt": "2024-01-15T09:30:00Z",
119           "isCurrent": true,
120           "isHq": true,
121           "isPrimary": true
122         }
123       ],
124       "personId": "string",
125       "personImage": {
126         "isMonogram": true,
127         "picture": "string"
128       },
129       "personName": "string",
130       "personSlug": "aventure-vc",
131       "personUrlLink": [
132         {
133           "url": "https://example.com",
134           "urlType": "website",
135           "crawlCdnProvider": "cloudflare",
136           "crawlRenderMode": "static",
137           "createdAt": "2024-01-15T09:30:00Z",
138           "id": 1,
139           "isCurrent": true,
140           "isPrimary": true,
141           "owner": {
142             "entityId": "string",
143             "personId": "string"
144           },
145           "sourceId": "string",
146           "status": "string",
147           "statusChecked": "2024-01-15T09:30:00Z",
148           "updatedAt": "2024-01-15T09:30:00Z"
149         }
150       ],
151       "createdAt": "2024-01-15T09:30:00Z",
152       "creator": "string",
153       "endDate": "2024-01-15T09:30:00Z",
154       "entityName": "string",
155       "entityOperatingStatus": "string",
156       "entityType": "Company",
157       "isCurrent": true,
158       "score": 1,
159       "startDate": "2024-01-15T09:30:00Z",
160       "titleFunction": "string",
161       "titleId": 1,
162       "titleLevel": "string",
163       "titleName": "string",
164       "updatedAt": "2024-01-15T09:30:00Z"
165     }
166   ],
167   "empty": true,
168   "first": true,
169   "last": true,
170   "number": 1,
171   "numberOfElements": 1,
172   "pageable": {
173     "offset": 1,
174     "pageNumber": 1,
175     "pageSize": 1,
176     "paged": true,
177     "sort": {
178       "empty": true,
179       "sorted": true,
180       "unsorted": true
181     },
182     "unpaged": true
183   },
184   "size": 1,
185   "sort": {
186     "empty": true,
187     "sorted": true,
188     "unsorted": true
189   },
190   "totalElements": 1,
191   "totalPages": 1
192 }

Returns entity associations for one person.

Authentication

X-Client-Secretstring

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

Path parameters

personIdstringRequiredformat: "uuid"

Person UUID

Query parameters

countOnlybooleanOptional

Return count metadata without full content

includeUrlbooleanOptional

Include entity URL records

permitMonogrambooleanOptional

Permit generated monogram logo fallback

cursorstringOptional

Opaque URL-safe cursor token from X-Next-Cursor

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 20

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