--- title: "Get Location Suggestions" method: GET path: "/locations/suggestions" tags: ["Suggestions"] --- # Get Location Suggestions `GET /locations/suggestions` Get a list of suggestions for all locations managed by the logged user ## Query parameters - `query` string - `sort` string - `order` string - `max` integer - `identifier` string - `offset` integer - `businessId` integer[] - `locationIds` integer[] ## Response `200` Successfully retrieved suggestions - object - `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 - `message` string — (optional) Holds further information about the response - `warnings` string[] — (optional) Holds further warnings - `response` object, required — Search response object containing pagination details and a list of suggestion responses - `offset` integer — Offset for pagination - `max` integer — Maximum number of results per page - `count` integer — Total count of results - `locations` object[] - `id` integer — Id of the location - `name` string — Name of the location - `streetAndNumber` string — Street and streetNumber of the location - `zip` string — Zip of the location - `city` string — City of the location - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UK' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — Country of the location - `status` 'CREATED' | 'ACTIVE' | 'INACTIVE' | 'CANCELLED' | 'DELETED' | 'CLOSED' — Status of the location - `suggestionsForFields` object[] — Map containing fields and the suggested values from different directories. - `fieldName` string — Name of the field for which the suggestion is provided - `currentValue` object — Current value of the field, can be String, List, etc. - `suggestions` object[] — The suggestions for the field - `id` integer — id of the Suggestion - `type` 'FOURSQUARE' | 'UBER' | 'GOOGLE' | 'WAZE' | 'GOOGLE_MAPS' | 'YELP_API' | 'MEINESTADT' | 'NOKIA_HERE' | 'FACEBOOK' | 'TOMTOM' | 'STADTBRANCHENBUCH' | 'CYLEX' | 'UNTERNEHMENSAUSKUNFT' | 'ACOMPIO' | 'BUSINESSBRANCHENBUCH' | 'SCOOT' | 'CENTRAL_INDEX' | 'CITIPAGES' | 'THE_DAILY_RECORD' | 'THE_EVENING_STANDARD' | 'THE_SCOTSMAN' | 'LIVERPOOL_ECHO' | 'TOUCH_LOCAL' | 'THE_MIRROR' | 'ANNUAIRE' | 'INFOBEL' | 'US_INFO_COM' | 'BING' | 'WO_GIBTS_WAS' | 'KOOMIO' | 'OEFFNUNGSZEITENBUCH' | 'APPLE_MAPS' | 'WHERE_TO' | 'TUPALO' | 'BRANCHENBUCH_DEUTSCHLAND' | 'MARKTPLATZ_MITTELSTAND' | 'BUSQUEDA_LOCAL' | 'RICERCARE_IMPRESE' | 'PAGES24' | 'NAVMII' | 'AUDI' | 'BMW' | 'MERCEDES' | 'VW' | 'TOYOTA' | 'FORD' | 'FIAT' | 'GM' | 'INSTAGRAM' | 'CITY_SQUARES' | 'SHOWMELOCAL' | 'CHAMBER_OF_COMMERCE' | 'JUDYS_BOOK' | 'MY_LOCAL_SERVICES' | 'HOTFROG' | 'INFO_IS_INFO' | 'MANTA' | 'US_CITY' | 'GO_YELLOW' | 'N49' | 'PRATIQUE' | 'EZLOCAL' | 'ELOCAL' | 'YELLOW_PAGES' | 'SUPER_PAGES' | 'DEX_KNOWS' | 'KAUFDA_MANUAL' | 'I_GLOBAL' | 'BRANCHEN_INFO_MANUAL' | 'GUTE_BANKEN_MANUAL' | 'D_11880_COM_MANUAL' | 'BANKOEFFNUNGSZEITEN_DE_MANUAL' | 'BANK_OEFFNUNGSZEITEN_DE_MANUAL' | 'CYLEX_MANUAL' | 'FINDE_OFFEN_MANUAL' | 'MEIN_PROSPEKT_MANUAL' | 'FIND_OPEN' | 'GO_LOCAL' | 'MEINUNGSMEISTER' | 'YAHOO_MANUAL' | 'TRIP_ADVISOR' | 'ZIP_CH' | 'INFOGROUP' | 'TRUSTPILOT' | 'AUSKUNFT' | 'NEXT_DOOR' | 'GOOGLE_ASSISTANT' | 'SIRI' | 'HUAWEI' | 'DOCTOR_COM' | 'DENTAL_PLANS' | 'DOC_SPOT' | 'HEALTHGRADES' | 'SHARE_CARE' | 'VITALS' | 'WEB_MD' | 'WELLNESS' | 'BING_HEALTH' | 'NPPES' | 'RATE_MDS' | 'CITYSEARCH' | 'INSIDER_PAGES' | 'TWITTER' | 'ALEXA' | 'MAP_QUEST' | 'WEBSITE_WIDGETS' | 'ECO_MOVEMENT' | 'GOOGLE_EV' | 'APPLE_EV' | 'TESLA_EV' | 'EUROWAG_EV' | 'OPIS_EV' | 'TOMTOM_EV' | 'HERE_EV' | 'YELLOW_PAGES_CANADA' | 'BBB' | 'UBERALL_SOCIAL_ADS' | 'APPLE_APPS' | 'CONSUMER_AFFAIRS' | 'CREDIT_KARMA' | 'DELIVERY' | 'GLASSDOOR' | 'PLAY_GOOGLE' | 'GRUBHUB' | 'INDEED' | 'LENDING_TREE' | 'MENUISM' | 'OPEN_TABLE' | 'OPEN_TABLE_USA' | 'WALLET_HUB' | 'ZILLOW' | 'ZOMATO' | 'WHATS_APP' | 'FOUR_SCREEN' | 'AND_CHARGE' | 'LINKED_IN' | 'TIK_TOK' | 'CHAT_GPT' | 'CLAUDE' | 'GEMINI' | 'PERPLEXITY' | 'OVERTURE' | 'RESTAURANTS' - `status` 'HIDDEN' | 'PENDING' | 'ACCEPTED' | 'DECLINED' | 'DECLINED_OLD_API' — ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion) - `value` object — Suggestion Value - `directory` 'FOURSQUARE' | 'UBER' | 'GOOGLE' | 'WAZE' | 'GOOGLE_MAPS' | 'YELP' | 'YELP_API' | 'MEINESTADT' | 'YELLOW_MAP' | 'FOCUS' | 'LOKALEAUSKUNFT' | 'WEB_DE' | 'GMX' | 'ONE_AND_ONE' | 'FREIEAUSKUNFT' | 'POINTOO' | 'NOKIA_HERE' | 'FACEBOOK' | 'TOMTOM' | 'STADTBRANCHENBUCH' | 'CYLEX' | 'UNTERNEHMENSAUSKUNFT' | 'ACOMPIO' | 'BUSINESSBRANCHENBUCH' | 'YALWA' | 'THE_PHONEBOOK' | 'SCOOT' | 'CENTRAL_INDEX' | 'CITIPAGES' | 'ONE_NINE_TWO' | 'ONE_ONE_EIGHT' | 'THE_DAILY_RECORD' | 'THE_EVENING_STANDARD' | 'THE_SCOTSMAN' | 'LIVERPOOL_ECHO' | 'THE_SUN' | 'THE_INDEPENDENT' | 'TOUCH_LOCAL' | 'THE_MIRROR' | 'ANNUAIRE' | 'INFOBEL' | 'US_INFO_COM' | 'GARMIN' | 'FACTUAL' | 'BING' | 'WO_GIBTS_WAS' | 'KOOMIO' | 'ABCLOCAL' | 'YELLBO' | 'JELLOO' | 'GUIDELOCAL' | 'OEFFNUNGSZEITENBUCH' | 'APPLE_MAPS' | 'LOOCAL' | 'REGIONAL_DE' | 'WHERE_TO' | 'TUPALO' | 'GELBE_SEITEN' | 'DAS_OERTLICHE' | 'DIALO' | 'BUNDES_TELEFONBUCH' | 'BRANCHENBUCH_DEUTSCHLAND' | 'MARKTPLATZ_MITTELSTAND' | 'BUSQUEDA_LOCAL' | 'RICERCARE_IMPRESE' | 'PAGES24' | 'NAVMII' | 'AUDI' | 'BMW' | 'MERCEDES' | 'VW' | 'TOYOTA' | 'FORD' | 'FIAT' | 'GM' | 'ETRUSTED' | 'INSTAGRAM' | 'SHOPPING_TIME_NETWORK' | 'CITY_SQUARES' | 'SHOWMELOCAL' | 'LOCALSTACK' | 'CHAMBER_OF_COMMERCE' | 'JUDYS_BOOK' | 'BROWNBOOK' | 'MY_LOCAL_SERVICES' | 'YA_SABE' | 'UNIVISION' | 'AL_DIA_TX' | 'LA_VOZ_TX' | 'CHRON' | 'STATESMAN' | 'PALM_BEACH_POST' | 'MUNDO_HISPANICO' | 'EL_TIEMPO_LATINO' | 'LATINOS_US' | 'HOTFROG' | 'INFO_IS_INFO' | 'MANTA' | 'US_CITY' | 'GO_YELLOW' | 'N49' | 'PRATIQUE' | 'JUSTACOTE' | 'EZLOCAL' | 'ELOCAL' | 'TRUE_LOCAL' | 'START_LOCAL' | 'WOMO' | 'AUSSIE_WEB' | 'YELLOW_PAGES' | 'SUPER_PAGES' | 'WHITE_PAGES' | 'DEX_KNOWS' | 'KAUFDA_MANUAL' | 'I_GLOBAL' | 'BRANCHEN_INFO_MANUAL' | 'GUTE_BANKEN_MANUAL' | 'D_11880_COM_MANUAL' | 'BANKOEFFNUNGSZEITEN_DE_MANUAL' | 'BANK_OEFFNUNGSZEITEN_DE_MANUAL' | 'CYLEX_MANUAL' | 'FINDE_OFFEN_MANUAL' | 'MEIN_PROSPEKT_MANUAL' | 'DAS_SCHNELLE' | 'SENSIS_WHITE_PAGES' | 'SENSIS_TRUE_LOCAL' | 'SENSIS_YELLOW_PAGES' | 'FIND_OPEN' | 'WAND' | 'BELL_CA' | 'GO_LOCAL' | 'MEINUNGSMEISTER' | 'YANDEX' | 'YAHOO_MANUAL' | 'HOLIDAY_CHECK' | 'TRIP_ADVISOR' | 'BONIAL_FR' | 'ZIP_CH' | 'PAGES_JAUNES' | 'YELLOW_PAGES_SINGAPORE' | 'INFOGROUP' | 'WAZE_NEW' | 'UBER_NEW' | 'NEUSTAR' | 'TRUSTPILOT' | 'AUSKUNFT' | 'BAIDU' | 'NEXT_DOOR' | 'MICROSOFT_CORTANA' | 'GOOGLE_ASSISTANT' | 'CBANQUE' | 'ORANGE_118_712' | 'SIRI' | 'HUAWEI' | 'DOCTOR_COM' | 'CARE_DASH' | 'DENTAL_PLANS' | 'DOC_SPOT' | 'HEALTHGRADES' | 'SHARE_CARE' | 'VITALS' | 'WEB_MD' | 'WELLNESS' | 'ZOC_DOC' | 'ZWIVEL' | 'YP_COM_HEALTH' | 'BING_HEALTH' | 'NPPES' | 'RATE_MDS' | 'CITYSEARCH' | 'INSIDER_PAGES' | 'TWITTER' | 'ALEXA' | 'MAP_QUEST' | 'WEBSITE_WIDGETS' | 'ECO_MOVEMENT' | 'GOOGLE_EV' | 'APPLE_EV' | 'TESLA_EV' | 'EUROWAG_EV' | 'OPIS_EV' | 'TOMTOM_EV' | 'HERE_EV' | 'YELLOW_PAGES_CANADA' | 'BBB' | 'UBERALL_SOCIAL_ADS' | 'APPLE_APPS' | 'CONSUMER_AFFAIRS' | 'CREDIT_KARMA' | 'DELIVERY' | 'GLASSDOOR' | 'PLAY_GOOGLE' | 'GRUBHUB' | 'INDEED' | 'LENDING_TREE' | 'MENUISM' | 'OPEN_TABLE' | 'OPEN_TABLE_USA' | 'WALLET_HUB' | 'ZILLOW' | 'ZOMATO' | 'WHATS_APP' | 'FOUR_SCREEN' | 'AND_CHARGE' | 'LINKED_IN' | 'TIK_TOK' | 'CHAT_GPT' | 'CLAUDE' | 'GEMINI' | 'PERPLEXITY' | 'OVERTURE' | 'RESTAURANTS' — Suggestion from directory ## Other responses - `400` — Bad Request - The request was invalid or cannot be otherwise served - `401` — Unauthorized - Authentication credentials are missing or invalid - `403` — Forbidden - The request is understood, but has been refused or access is not allowed - `404` — Not Found - The requested resource could not be found --- [API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/a506e82d7cbe/schema)