Skip to content
API Reference/
/
Get suggestions

Get suggestions

Request

Get location suggestions given a search data

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Query
languagestring

Filter suggestion attributes by language

directoryTypesstring

Filter suggestions by directories

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/suggestions?language=string&directoryTypes=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suggestions

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

Suggestion Response Model

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "id": 0,
    "name": "string",
    "streetAndNumber": "string",
    "zip": "string",
    "city": "string",
    "country": "AF",
    "status": "CREATED",
    "suggestionsForFields": [
      {
        "fieldName": "string",
        "currentValue": {},
        "suggestions": [
          {
            "id": 0,
            "type": "FOURSQUARE",
            "status": "HIDDEN",
            "value": {},
            "directory": "FOURSQUARE"
          }
        ]
      }
    ]
  }
}