List locations by scope

GET

https://api.aventure.vc/v1/addresses/locations/:directory

GET

/v1/addresses/locations/:directory

curl -G https://api.aventure.vc/v1/addresses/locations/countries \
     -d letter=A

{
  "content": [
    {
      "canonicalSlug": "string",
      "entityCount": 1,
      "identifier": {
        "scope": "country",
        "cityId": 1,
        "cityName": "string",
        "countryId": 1,
        "countryIso2": "string",
        "countryName": "string",
        "stateAbbrev": "string",
        "stateId": 1,
        "stateName": "string"
      },
      "name": "string",
      "slug": "string",
      "latestUpdatedAt": "2024-01-15T09:30:00Z",
      "parentLabel": "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
}

Paginated directory of locations filtered by scope and starting letter

Path parameters

directoryenumRequired

Location directory (countries, states, cities)

Query parameters

letterstringOptionalDefaults to A

Starting letter filter

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 100

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