Get all locations

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description

swagger.json

swagger.yaml

Overview

URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Servers

Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Get all locations

Request

Get all locations in your store finder

Path

storeKeystringrequired

Your store finder key

Query

countryArray of strings

Optional parameter to filter locations from a specific country

fieldMaskArray of strings

The list of fields the response object should contain

Example: fieldMask=fieldMask=name&fieldMask=id

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/store-finders/{storeKey}/locations/all?country=string&fieldMask=fieldMask%3Dname%26fieldMask%3Did' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.locationsArray of objects(StoreFinderResponse)

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "locations": [ … ]
  }
}

Get location details

Request

Get details for a specific location within the store finder

Path

storeKeystringrequired

Your store finder key

idstringrequired

The location id, identifier or a custom slug

Query

languagestring

The language the location data should be returned in (only applicable if location translation feature is enabled)

Example: language=en

countryArray of strings

Countries to filter for

customFieldsboolean

Should customFields be included in the response

identifierboolean

When true id is the location identifier otherwise its id

reviewRatingsArray of strings

Review ratings to include in the detailed response

Items Enum"1""2""3""4""5"

slugstring

If a slug was provided as ID which customField should we match it for

fieldMaskArray of strings

The list of fields the response object should contain, in the following format: "fieldMask=name&fieldMask=id"

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/store-finders/{storeKey}/locations/{id}**?country=string&customFields=true&fieldMask=string&identifier=true&language=en&reviewRatings=1&slug=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

This is a response object that is being used in storefinder calls

response.addressExtrastring

Additional address information, e.g. building, floor, etc.

Example: "building, floor, etc."

response.averageRatingnumber(float)

The average rating of all Google Reviews

response.brandsArray of stringsunique

The brands offered by the location to its customers

response.businessIdinteger(int64)

The id of the business associated with this location

response.businessNamestring

Name of the business

response.businessIdentifierstring

The business identifier based on your internal identification system

response.callToActionsArray of objects(CallToAction)

A list of callToAction objects, each with a title and URL, formatted as

callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text: 'cta_text2', url: 'cta_url2' }]

Example: "callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text: 'cta_text2', url: 'cta_url2' }]"

response.categoriesArray of objects(StoreFinderCategoriesDetails)

A list of category IDs describing the location

response.cellphonestring

A contact mobile phone number

response.citystring

The city the location is residing in.

response.countrystring

The country the location is residing in.

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

response.customItemsArray of objects(CustomItem)

Custom, rich content related specifically to this location (such as company values)

response.descriptionLongstring

A long description - up to 1000 characters

response.descriptionShortstring

A short description - up to 200 characters

response.emailstring

A contact email for the location

response.eventsArray of objects(Event)

Events offered by this location

response.faxstring

The location fax number

response.idinteger(int64)

The uberall unique id for the location.

response.identifierstring

The location identifier based on your internal identification system.

response.imprintstring

The imprint of the location

response.keywordsArray of strings

Keywords describing the locations activity

response.languagesArray of stringsunique

The language(s) in which customers can interact with the location's staff

response.latnumber(double)

The latitude coordinate of the location.

response.lngnumber(double)

The longitude coordinate of the location.

response.menusArray of objects(MenuItem)

Menu items offered by this location

response.namestring

The location's name.

response.nextOpenobject

Next Open Model

response.openingHoursArray of objects(OpeningHours)unique

The location's opening hours.

response.openingHoursNotesstring

Additional information about the location's opening hours.

response.specialOpeningHoursArray of objects(SpecialOpeningHours)unique

The location's special opening hours

response.openNowboolean

Shows if the location is currently open.

response.paymentOptionsArray of stringsunique

The payment options accepted at the location (eg. cash, bank transfer, ...)

Example: "cash, bank transfer, ..."

response.peopleArray of objects(Person)

People associated with this location

response.phonestring

The location's contact phone number.

response.photosArray of objects(LocationPhoto)unique

The location's photos.

response.productsArray of objects(Product)

Products offered by this location

response.provincestring

The province the location is residing in.

response.reviewCountinteger(int32)

How many Google Reviews this location has in total

response.reviewsArray of objects(StoreFinderReview)

A list of up to five Google Reviews

response.servicesArray of objects(ServiceItem)

The services offered by the location (eg. 'catering' for a restaurant)

Example: "'catering' for a restaurant"

response.socialProfilesArray of objects(SocialProfile)unique

The profiles of the location on social and professional networks (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER, VIMEO, XING, YOUTUBE)

response.socialPostobject

Social posts published for this location

response.streetAndNumberstring

The location's street address.

response.taxNumberstring

The tax number of the location. CIF/NIF in Spain

response.timezonestring

The location's timezone

response.videosArray of objects(Video)unique

The location's videos

response.zipstring

The location's ZIP code.

response.websitestring

A valid url for the location's website

response.googlePlaceIdstring

A unique textual identifier to identify a place in the Google Places database and on Google Maps.

response.streetstring

The location's street address

response.streetNostring

The location's street number

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "addressExtra": "building, floor, etc.",
    "averageRating": 0.1,
    "brands": [ … ],
    "businessId": 0,
    "businessName": "string",
    "businessIdentifier": "string",
    "callToActions": "callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text: 'cta_text2', url: 'cta_url2' }]",
    "categories": [ … ],
    "cellphone": "string",
    "city": "string",
    "country": "AF",
    "customItems": [ … ],
    "descriptionLong": "string",
    "descriptionShort": "string",
    "email": "string",
    "events": [ … ],
    "fax": "string",
    "id": 0,
    "identifier": "string",
    "imprint": "string",
    "keywords": [ … ],
    "languages": [ … ],
    "lat": 0.1,
    "lng": 0.1,
    "menus": [ … ],
    "name": "string",
    "nextOpen": { … },
    "openingHours": [ … ],
    "openingHoursNotes": "string",
    "specialOpeningHours": [ … ],
    "openNow": true,
    "paymentOptions": "cash, bank transfer, ...",
    "people": [ … ],
    "phone": "string",
    "photos": [ … ],
    "products": [ … ],
    "province": "string",
    "reviewCount": 0,
    "reviews": [ … ],
    "services": "'catering' for a restaurant",
    "socialProfiles": [ … ],
    "socialPost": {},
    "streetAndNumber": "string",
    "taxNumber": "string",
    "timezone": "string",
    "videos": [ … ],
    "zip": "string",
    "website": "string",
    "googlePlaceId": "string",
    "street": "string",
    "streetNo": "string"
  }
}

Get all possible filter values

Request

Will return all possible filter values for the given store finder. If locations are eligible for translations and a language is provided it will translate the values.

Path

storeKeystringrequired

Your store finder key

Query

languagestring

The language to show the filter values in

Example: language=en

countryArray of strings

Optional parameter to filter locations from a specific country

Example: country=FR

filtersArray of strings

The names of the filters for which the values should be returned

Example: filters=services

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/store-finders/{storeKey}/filters?country=FR&filters=services&language=en' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Store Finder Filters Model

response.filtersobject

All filters with their possible values, including services

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "filters": { … }
  }
}

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Uberall API (20250204)

Users

Business Connections

Businesses

Configuration

Sales Partners

Monitoring

Product Plans

Webhooks

Auto Response

Brand Data Points

Dashboard

Dashboard Exports

Data Points

Data Point Filters

Templates

Social Posting

Social Posting Templates

Digital Asset Management

Status Check

Store Finder

Get all locations

Request

Responses

Was this helpful?

Get location details

Request

Responses

Was this helpful?

Get all possible filter values

Request

Responses

Was this helpful?

Batch Operation

Categories

Collection Management

Content List

Locations Data

Custom Items

Events

Listings

Labels

Location Groups

Menu Items

Persons

Locations Photos

Products

Service Items

Suggestions