PRpromorepublic
Locations Data

Get the city for locations

Get the location's city

get/locations/cities

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Query parameters

locationIdsstring[]

Get the cities for locations by location Ids

businessIdsstring[]

Get the cities for locations by business id

postcodesstring[]

Get the cities for locations by postcodes

countriesstring[]

Get the cities for locations by country

provincesstring[]

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

Maximum number of items to return

offsetinteger

Offset used for pagination. Default: 0

Response

Cities successfully retrieved

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "cities": [
      "City1",
      "City2"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.