List the people at a company

GET

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

GET

/v1/entities/:entityId/people

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

{
  "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": "website",
          "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": "website",
          "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": "2024-01-15T09:30:00Z",
      "entityName": "string",
      "entityOperatingStatus": "string",
      "entityType": "Company",
      "isCurrent": true,
      "score": 1,
      "startDate": "2024-01-15T09:30:00Z",
      "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 people associated with one entity. Public results exclude hidden entities; callers with private-visibility authority can include them.

Path parameters

entityIdstringRequiredformat: "uuid"

Entity UUID

Query parameters

searchstringOptional

Search term filter

rolestringOptional

Match the complete titleName, ignoring case (for example, Co-Founder & CEO). Omit to include all titles; this does not filter titleFunction or titleLevel.

isCurrentbooleanOptional

Current association filter

includeUrlbooleanOptional

Include person URL records

includeAddressbooleanOptional

Include person address records

personSlugstringOptional

Person slug fallback for entity-keyed writes

countOnlybooleanOptional

Return count metadata without full content

permitMonogrambooleanOptional

Permit generated monogram fallback

includePrivatebooleanOptional

Includes associations on hidden entities when the caller has private-visibility authority. Omit to use the caller’s default visibility.

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 headers

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