List a company's locations

GET

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

GET

/v1/entities/:entityId/addresses

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

[
  {
    "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
  }
]

Returns current physical addresses with their role-period associations, ordered HQ-first, primary-next, most-recent-first (updated_at DESC). Reads directly from the base tables so fresh writes surface immediately (bypassing the mv_entity_addresses materialized view). Set includeInactive=true as a signed-in user or with read credentials to include inactive/historical rows.

Returns current physical addresses with their role-period associations, ordered HQ-first, primary-next, most-recent-first (`updated_at DESC`). Reads directly from the base tables so fresh writes surface immediately (bypassing the mv_entity_addresses materialized view). Set includeInactive=true as a signed-in user or with read credentials to include inactive/historical rows.

Path parameters

entityIdstringRequiredformat: "uuid"

Canonical entity UUID

Query parameters

includeInactivebooleanOptionalDefaults to false

Include inactive rows

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

addressinteger or nullOptional

Legacy address row identifier

addressLine1string or nullOptional

addressLine2string or nullOptional

associationlist of objectsOptional

Role-period associations for this physical address

cityobject or nullOptional

City reference

countryobject or nullOptional

Country reference

countryAbbrevstring or nullOptional

createdAtdatetime or nullOptional

fullAddressstring or nullOptional

Single-line formatted address

idinteger or nullOptional

Address record identifier

latitudedouble or nullOptional

longitudedouble or nullOptional

postalCodestring or nullOptional

stateobject or nullOptional

State or region reference

stateAbbrevstring or nullOptional

streetstring or nullOptional

updatedAtdatetime or nullOptional

isCurrentboolean or nullOptionalDeprecated

Deprecated aggregate compatibility flag; true when any association is current

isHqboolean or nullOptionalDeprecated

Deprecated legacy flag marking the headquarters or legal/registered address

isPrimaryboolean or nullOptionalDeprecated

Deprecated legacy flag marking the primary display address

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