List a Person's Roles at Companies

GET

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

GET

/v1/people/:personId/entities

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

{
  "content": [
    {
      "associationId": 1,
      "entityAddress": [
        {
          "address": 456,
          "addressLine1": "string",
          "addressLine2": "string",
          "association": [
            {
              "id": 123,
              "isCurrent": true,
              "endDate": "2023-01-15",
              "role": "domicile",
              "startDate": "2023-01-15"
            }
          ],
          "city": {
            "name": "Boston",
            "id": 1
          },
          "country": {
            "name": "United States",
            "countryCodeChar2": "US",
            "countryCodeChar3": "USA",
            "id": 1,
            "unRegion": "string",
            "unSubregion": "string"
          },
          "countryAbbrev": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "fullAddress": "123 Main St, Boston, MA 02110, USA",
          "id": 123,
          "latitude": 1.1,
          "longitude": 1.1,
          "postalCode": "string",
          "state": {
            "name": "Massachusetts",
            "id": 1,
            "stateAbbrev": "MA"
          },
          "stateAbbrev": "string",
          "street": "string",
          "updatedAt": "2024-01-15T09:30:00Z",
          "isCurrent": true,
          "isHq": true,
          "isPrimary": true
        }
      ],
      "entityId": "string",
      "entityLogo": {
        "isMonogram": true,
        "logo": "string",
        "logoSquare": "string"
      },
      "entitySlug": "aventure-vc",
      "entityUrlLink": [
        {
          "url": "https://example.com",
          "urlType": "string",
          "crawlCdnProvider": "cloudflare",
          "crawlRenderMode": "static",
          "createdAt": "2024-01-15T09:30:00Z",
          "id": 1,
          "isCurrent": true,
          "isPrimary": true,
          "owner": {
            "entityId": "string",
            "personId": "string"
          },
          "sourceId": "string",
          "status": "string",
          "statusChecked": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "personAddress": [
        {
          "address": 456,
          "addressLine1": "string",
          "addressLine2": "string",
          "association": [
            {
              "id": 123,
              "isCurrent": true,
              "endDate": "2023-01-15",
              "role": "domicile",
              "startDate": "2023-01-15"
            }
          ],
          "city": {
            "name": "Boston",
            "id": 1
          },
          "country": {
            "name": "United States",
            "countryCodeChar2": "US",
            "countryCodeChar3": "USA",
            "id": 1,
            "unRegion": "string",
            "unSubregion": "string"
          },
          "countryAbbrev": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "fullAddress": "123 Main St, Boston, MA 02110, USA",
          "id": 123,
          "latitude": 1.1,
          "longitude": 1.1,
          "postalCode": "string",
          "state": {
            "name": "Massachusetts",
            "id": 1,
            "stateAbbrev": "MA"
          },
          "stateAbbrev": "string",
          "street": "string",
          "updatedAt": "2024-01-15T09:30:00Z",
          "isCurrent": true,
          "isHq": true,
          "isPrimary": true
        }
      ],
      "personId": "string",
      "personImage": {
        "isMonogram": true,
        "picture": "string"
      },
      "personName": "string",
      "personSlug": "aventure-vc",
      "personUrlLink": [
        {
          "url": "https://example.com",
          "urlType": "string",
          "crawlCdnProvider": "cloudflare",
          "crawlRenderMode": "static",
          "createdAt": "2024-01-15T09:30:00Z",
          "id": 1,
          "isCurrent": true,
          "isPrimary": true,
          "owner": {
            "entityId": "string",
            "personId": "string"
          },
          "sourceId": "string",
          "status": "string",
          "statusChecked": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "endDate": "string",
      "entityName": "string",
      "entityOperatingStatus": "string",
      "entityType": "Company",
      "isCurrent": true,
      "score": 1,
      "startDate": "string",
      "titleFunction": "string",
      "titleId": 1,
      "titleLevel": "string",
      "titleName": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 1,
  "totalPages": 1
}

Returns entity associations for one person.

Path parameters

personIdstringRequiredformat: "uuid"

Person UUID

Query parameters

pageintegerOptional>=0

Zero-based page index for offset paging; omit it for the first page. Ignored when cursor is sent: to continue a cursor traversal, send the X-Next-Cursor value as cursor and leave page out.

countOnlybooleanOptional

Return count metadata without full content

includeUrlbooleanOptional

Include entity URL records

includeAddressbooleanOptional

Include entity address records (pass false to omit)

permitMonogrambooleanOptional

Permit generated monogram logo fallback

cursorstringOptional

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

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 headers

X-Next-CursorstringOptional

Opaque continuation token, present when another page exists; send it as cursor to read that page. The body’s number, first, and totalPages describe offset paging only; they do not advance while you follow cursors.

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

contentlist of objectsOptional

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberintegerOptional

numberOfElementsintegerOptional

pageableobjectOptional

sizeintegerOptional

sortobjectOptional

totalElementslongOptional

totalPagesintegerOptional

Errors

400

Bad Request Error

404

Not Found Error

406

Not Acceptable Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error