--- title: "Get Several Locations" method: GET path: "/locations" tags: ["Locations Data"] --- # Get Several Locations `GET /locations` Get locations managed by the current API user. Some fields are omitted (such as paymentOptions and services). For a full list use the GET/api/locations/$id endpoint. ## Query parameters - `businessId` integer[] - `businessIds` integer[] - `cities` string[] - `classification` string - `countries` string[] - `endDateMax` string, date-time - `endDateMin` string, date-time - `excludedLocationIds` integer[] - `facebookStatus` string - `fieldMask` string[] - `googleDirectoryStatus` string - `googleStatus` string - `groupIds` integer[] - `groups` string[] - `identifier` string - `labels` string[] - `locationIds` integer[] - `max` integer - `missingDirectoryField` string[] - `needsReview` boolean - `offset` integer - `order` string - `postcodes` string[] - `provinces` string[] - `query` string - `queryFields` string[] - `selectAll` boolean - `sort` string - `status` string[] - `syncNeeded` boolean - `syncStarted` boolean - `temporarilyClosed` boolean ## Response `200` Locations successfully retrieved - 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 — The actual response object of the response - `offset` integer — Offset for pagination - `max` integer — Maximum number of results per page - `count` integer — Total count of results - `locations` object[] - `id` integer — The uberall unique id for the location - `identifier` string — The location identifier based on your internal identification system - `name` string — The location's name - `street` string — The location's street address - `streetNo` string — The location's street number - `streetType` 'ALAMEDA' | 'AVENIDA' | 'CALLE' | 'CAMINO' | 'CARRER' | 'CARRETERA' | 'GLORIETA' | 'KALEA' | 'PASAJE' | 'PASEO' | 'PLACA' | 'PLAZA' | 'RAMBLA' | 'RONDA' | 'RUA' | 'SECTOR' | 'TRAVESERA' | 'TRAVESIA' | 'URBANIZACION' — Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION - `addressExtra` string — An address extra: e.g. building, floor... - `addressDisplay` boolean — If set to false, directories are either not given address details or told not to display them. There are few directories where this is not possible, that hence might not receive data at all. - `zip` string — Zip code - `city` string — City - `province` string — Province. Only send when not blank - `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. One of AT, CH, DE, ES, UK, FR, IT, NL - `lat` number, double — The latitude coordinate of the location - `lng` number, double — The longitude coordinate of the location - `locationSyncable` boolean — Boolean indicating whether the location has been updated and can be synced - `phone` string — The location's contact phone number - `fax` string — The location fax number - `cellphone` string — A contact mobile phone number - `website` string — A valid url for the location's website (use UTMs to add tracking) - `email` string — A contact email for the location - `hasFacebook` boolean — Boolean indicating whether the location has support Facebook included in its product plan - `legalIdent` string — A legal identifier of the location. SIRET number in France - `taxNumber` string — The tax number of the location. CIF/NIF in Spain - `descriptionShort` string — A short description (up to 200 characters) for the location - `descriptionLong` string — A long description (up to 1000 characters) for the location - `imprint` string — imprint of the location - `openingHoursNotes` string — Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters - `openingHours` object[] — The location's opening hours: e.g. 
[ { "dayOfWeek": 1, "closed": false, "from1": "08:00", "to1": "11:00" }, { "dayOfWeek": 2, "closed": false, "from1": "08:00", "to1": "11:00", "from2": "13:00", "to2": "21:00" }, { "dayOfWeek": 3, "closed": true } ]
Please note that having more than 2 time periods for each day is not possible. - `closed` boolean — Indicates whether a location is closed on a day. - `fromX` string — A beginning of a period. One or multiple periods are supported per dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00" - `dayOfWeek` integer, required — The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday, ... - `toX` string — An end of a period. One or multiple periods are supported per dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00" - `specialOpeningHours` object[] — The location's special opening hours: e.g. 
[ { "date": "2017-06-29", "closed": true }, { "date": "2017-06-30", "from1": "11:00", "to1": "14:00", "from2": "16:00", "to2": "20:00" } ]
Please note that having more than 2 time periods for each day is not possible. - `closed` boolean — Indicates whether a location is closed on a date. - `fromX` string — A beginning of a period. Up to two periods are supported per date, e.g.: "from1": "09:00", "from2": "15:00" - `toX` string — An end of a period. Up to two periods are supported per date, e.g.: "to1": "09:00", "to2": "15:00" - `date` string, required — The date of a special opening hour, e.g.: 2017-06-30 - `openNow` boolean — Used for store finder. Boolean indicating whether the location is currently open - `keywords` string[] — Keywords describing the location's activity - `labels` object[] — Labels grouping similar locations - `name` string, required — Label name as String. - `adminOnly` boolean — Permission on label, whether it can be used by admins or everyone. - `categories` integer[] — Required - A list of category IDs describing the location - `attributes` object[] — The location's Google attributes - `externalId` string — The google attribute id - `value` string — The value of the attribute. The value depends on the valueType.
BOOL: "true" or "false"
Single URL:"http://uberall.com"
Multiple URLs: ["http://uberall.com", "https://menuari2.com"]
ENUM:"supportedValue1" or "supportedValue2"
REPEATED_ENUM:"supportedValue1,supportedValue2" - `displayName` string — The attribute's name in the required language. - `groupDisplayName` string — Attribute group name - `valueMetadata` object[] — List of possible values. - `value` string — The value - `displayName` string — Display name for this value - `valueType` 'BOOL' | 'URL' | 'ENUM' | 'REPEATED_ENUM' — The attribute type. e.g. BOOL, URL, ENUM, REPEATED_ENUM - `status` 'CREATED' | 'ACTIVE' | 'INACTIVE' | 'CANCELLED' | 'DELETED' | 'CLOSED' — The status of the location. One of: - `lastSyncStarted` string, date-time — Output only. Date of the last sync for the location - `endDate` string, date-time — The date the location's contract expires - `cancellationDate` string, date-time — The date when the location was cancelled - `dateCreated` string, date-time — The date and time the location was created - `lastUpdated` string, date-time — Output only. Date of the last changes made to the location - `sortableData` object — A JSON indicating which parameters can be used when sorting a list of locations including this one - `activeDirectoriesCount` integer — Output only. Number of active directories - `activeListingsCount` integer — Output only. Number of active listings - `publishedListingsCount` integer — Number of managed online listings - `visibilityIndex` integer — Latest Visibility Index - `dataPoints` integer — Number of datapoints - `businessId` integer — Uberall Identifier of the location's business - `salesPartnerId` integer — Uberall identifier of the SalesPartner - `profileCompleteness` integer — Output only. Number representing completeness of location data, up to 100 - `missingMandatoryFields` string[] — Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE] - `directoriesMissingConnect` string[] — The list of DirectoryType missing connection - `listingsInSync` integer — number of listings still in sync - `listingsBeingUpdated` integer — Output only. Number of listings still being updated - `averageRating` number, double — Average rating, e.g. - `suggestionsForFieldsAvailable` boolean — Output Only. Boolean that indicates which locations have pending suggestions. - `businessId` integer — The id of the business associated with this location - `socialPostId` integer — Social Post Id of the location - `distance` integer — Used for store finder. The distance between the current position and this location - `photos` object[] — List of Photos - `description` string — A description for the photo - max 255 chars - `sourceUrl` string — Output only. The original source URL of the photo. To provide a photo URL when creating or updating a location, use the 'url' field instead. - `identifier` string — The photo identifier based on your internal identification system - `cropOffsetX` integer — Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only] - `cropOffsetY` integer — Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only] - `cropWidth` integer — Width of the 16:9 cropped area [LANDSCAPE photo only] - `cropHeight` integer — Height of the 16:9 cropped area [LANDSCAPE photo only] - `type` 'MAIN' | 'DOCTOR_COM_PORTRAIT' | 'LOGO' | 'STOREFINDER_LOGO' | 'SQUARED_LOGO' | 'LANDSCAPE' | 'STOREFINDER_COVER' | 'FACEBOOK_LANDSCAPE' | 'APPLE_LANDSCAPE' | 'MENU' | 'PHOTO' | 'ROOMS' | 'TEAMS' | 'AT_WORK' | 'PRODUCT' | 'EXTERIOR' | 'INTERIOR' | 'COMMON_AREA' | 'FOOD_AND_DRINK', required — Required - One of:
PHOTO - Default photo type for all photos which do not fit into any other category
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE - Apple Cover Photo - availability and usage dependent on directory rules
STOREFINDER_LOGO - Only for Uberall locator product
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category - `order` integer — Zero-based insertion index. If omitted, photo is added to the end - `dateCreated` string, date-time — The date when the object was created in uberall database - `lastUpdated` string, date-time — Date of the last changes made to the photo - `photo` string - `locationId` integer — The uberall unique id of the location to attach the photo to. - `url` string — URL of the photo to upload. Use this field (not sourceUrl) when providing a photo URL via the Location create/update endpoints. - `autoSync` boolean — When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once. - `skipFacebookPicturesUpdate` boolean — When set to true, Uberall will skip publishing any photos to Facebook for this location. This affects both sync checks and updates. - `suggestionsForFieldsAvailable` boolean — true if any suggetions are available - `features` string[] — Output only. List of features available to the location ## 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/revisions/ddc577c548ee/schema)