Get the city for locations

Request

Get the location's city

Security

X-API-KEY or Authorization

Query

locationIdsArray of strings

Get the cities for locations by location Ids

businessIdsArray of strings

Get the cities for locations by business id

postcodesArray of strings

Get the cities for locations by postcodes

countriesArray of strings

Get the cities for locations by country

provincesArray of strings

Get the cities for locations by province / state

querystring

Restricts the response to the cities that contain this text, for example "ber" would return "Berlin" when appropriate.

maxinteger, (int64)

Maximum number of items to return

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/locations/cities?locationIds=string&businessIds=string&postcodes=string&countries=string&provinces=string&query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Cities successfully retrieved

Body*/*

statusstringrequired

Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Cities response model

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "cities": [
      "City1",
      "City2"
    ]
  }
}