Get person entity association

GET

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

GET

/v1/people/:personId/entities/:associationId

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

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

Returns one person-scoped association join row.

Authentication

X-Client-Secretstring

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

Path parameters

personIdstringRequiredformat: "uuid"

Person UUID

associationIdintegerRequired

Association id

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

Response

associationIdinteger

Integer person-entity association join row id, not a person or entity UUID

entityAddresslist of objects

Entity addresses carried on the association projection

entityIdstringformat: "uuid"

Associated entity id

entityLogoobject

Entity logo image projection

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

Canonical lowercase URL slug for the resource

entityUrlLinklist of objects

Entity URL links carried on the association projection

personAddresslist of objects

Person addresses carried on the association projection

personIdstringformat: "uuid"

Associated person id

personImageobject

Person image projection

personNamestring

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

Canonical lowercase URL slug for the resource

personUrlLinklist of objects

Person URL links carried on the association projection

createdAtdatetime or nullOptional

creatorstring or nullOptional

Association creator label

endDatedatetime or nullOptional

Association period end timestamp

entityNamestring or nullOptional

entityOperatingStatusstring or nullOptional

entityTypeenum or nullOptional

Entity type classification

isCurrentboolean or nullOptional

scoreinteger or nullOptional

startDatedatetime or nullOptional

Association period start timestamp

titleFunctionstring or nullOptional

Read-side corporate title function for the association row

titleIdinteger or nullOptional

Corporate title id for the association row

titleLevelstring or nullOptional

Read-side corporate title level for the association row

titleNamestring or nullOptional

Read-side corporate title text for the association row

updatedAtdatetime or nullOptional

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