uberall API Endpoints

Before diving into the endpoints below, its generally useful to read our Overview to understand high-level concepts and use cases.

Base URLs

https://uberall.com/api/ - base url for the live system
https://sandbox.uberall.com/api/ - base url for the sandbox environment ( testing purposes )

Auto Response

GET	/api/auto-response/rules	List Auto Response Rules with filters
POST	/api/auto-response/rules	Create an Auto Response Rule
GET	/api/auto-response/rules/$id	Get an Auto Response Rule
PATCH	/api/auto-response/rules/$id	Edit an Auto Response Rule
DELETE	/api/auto-response/rules/$id	Delete an Auto Response Rule
POST	/api/auto-response/rules/check-conflict	Check for Auto Response Rule conflicts

GET

/api/auto-response/rules

https://uberall.com/api/auto-response/rules

[ RuleResponse ,...]

List Auto Response Rules with filters

Query Parameters

businesses

Only return Auto Response Rules identified by the business ids listed in businesses

direction

Direction to sort the results in, use asc for ascending sort or desc for descending sort

excludedLocations

List of location ids that should be excluded from the result

locations

Only return Auto Response Rules identified by the location ids listed in locations

page

Used for pagination. Default: 0

size

Used for pagination. Default: 10

sort

Field to sort the results in, use created_by, date_created or id

POST

/api/auto-response/rules

https://uberall.com/api/auto-response/rules

RuleResponse

Create an Auto Response Rule

Body Parameters

businesses

Required - Identify this Auto Response Rule with a list of business ids

String

excludedLocations

Required - Exclude a list of location ids from this Auto Response Rule

String

locations

Required - Identify this Auto Response Rule with a list of location ids

String

name

Required - Name for this Auto Response Rule, must not be longer than 255 characters

String

responses

Required - Possible responses for this Auto Response Rule. At least 3 non-empty responses must be provided

String

ruleResponses

Required - uberDoc.resource.api.auto-response.rules.POST.bodyParam.ruleResponses.description

String

status

Required - Status for this Auto Response Rule, either ACTIVE or INACTIVE if present, default is ACTIVE

String

triggers

Required - Triggers for this Auto Response Rule, use

ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR.

String

GET

/api/auto-response/rules/$id

https://uberall.com/api/auto-response/rules/$id

RuleResponse

Get an Auto Response Rule

Path parameters

id of Auto Response Rule

PATCH

/api/auto-response/rules/$id

https://uberall.com/api/auto-response/rules/$id

RuleResponse

Edit an Auto Response Rule

Edit an Auto Response Rule. The current user can edit this rule when they have access to all businesses and locations that identify this rule.

Path parameters

id of Auto Response Rule to be edited

Body Parameters

businesses

Required - Identify this Auto Response Rule with a list of business ids

String

excludedLocations

Required - Exclude a list of location ids from this Auto Response Rule

String

locations

Required - Identify this Auto Response Rule with a list of location ids

String

name

Required - Name for this Auto Response Rule, must not be longer than 255 characters

String

responses

Required - Possible responses for this Auto Response Rule. At least 3 non-empty responses must be provided, if this field is edited.

String

status

Required - Status for this Auto Response Rule, either ACTIVE or INACTIVE if present

String

triggers

Required - Triggers for this Auto Response Rule, use ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR

String

DELETE

/api/auto-response/rules/$id

https://uberall.com/api/auto-response/rules/$id

Map

Delete an Auto Response Rule

Delete an Auto Response Rule. Only rules that can be edited by the current user can be deleted

Path parameters

id of the Auto Response Rule to be deleted

POST

/api/auto-response/rules/check-conflict

https://uberall.com/api/auto-response/rules/check-conflict

ConflictingRuleResponse

Check for Auto Response Rule conflicts

Check if there are any other Auto Response Rules that have status ACTIVE, apply to at least one of the businesses or locations in this request, and share at least one of the triggers in this request. When editing an existing Auto Response Rule, its id should be passed in ignoreRule so that it is not returned as a false positive.

Body Parameters

businesses

Required - Only check Auto Response Rules identified by the business ids listed in businesses

String

excludedLocations

Required - List of location ids that should be excluded from the check

String

ignoreRule

Required - When editing an Auto Response Rule, send the id from the rule being edited in this field

String

locations

Required - Only check Auto Response Rules identified by the location ids listed in locations

String

triggers

Required - Only check Auto Response Rules that also apply to these triggers, use ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR

String

Batch endpoints

GET	/api/batch	Get all Location Imports
POST	/api/batch	Creates a new location import
GET	/api/batch/$id	Get information about a particular location import
POST	/api/batch/$id	Starts a location import
PATCH	/api/batch/$id	Send Location Data
GET	/api/batch/$id/error-report	Get Excel document with Location errors
POST	/api/batch/check	Get information about an import

GET

/api/batch

https://uberall.com/api/batch

Get all Location Imports

Returns a list of all existing location imports for the current user

Query Parameters

max

Used for pagination. Maximum number of results per page. Default: 10

offset

Offset used for pagination. Default: 0

order

use asc for ascending sort or desc for descending sort

sort

Order results by the specified field. Default is location id.

POST

/api/batch

https://uberall.com/api/batch

Creates a new location import

Creates a new location import. Make sure for each location to define their "row" (integer) in the body of your request. The location import has no data associated yet, use PATCH /api/batch/$id to add data to it. After that, the location import can be started with POST /api/batch/$id.

GET

/api/batch/$id

https://uberall.com/api/batch/$id

Get information about a particular location import

Path parameters

The uberall unique id of the location import

POST

/api/batch/$id

https://uberall.com/api/batch/$id

Starts a location import

Starts the location import. All uploaded chunks will be processed. A location import can only be started once.

Path parameters

The uberall unique id of the location import

PATCH

/api/batch/$id

https://uberall.com/api/batch/$id

Send Location Data

Uploads location data to a location import

Path parameters

Id of the location import

Query Parameters

collections

list of collections that should be created or updated

contentItems

list of contentItems that should be created or updated

locations

list of locations that should be created or updated

GET

/api/batch/$id/error-report

https://uberall.com/api/batch/$id/error-report

Get Excel document with Location errors

After a file import, a results report is created with all location failures. This endpoints allows downloading only the locations with errors.

Path parameters

The uberall unique id of the location import

POST

/api/batch/check

https://uberall.com/api/batch/check

Get information about an import

Get information about an import (how many locations/businesses would be created/updated)

Query Parameters

locations

list of locations that should be created or updated

Brand Data Points

POST	/api/brand-data-points/$id/like	Like a Brand Data Point
DELETE	/api/brand-data-points/$id/like	Unlike a Brand Data Point
PATCH	/api/brand-data-points/$id/reply	Reply to a Brand Data Point
POST	/api/brand-data-points/$id/reply/$replyId/approval	Approve reply to a Brand Data Point
PUT	/api/brand-data-points/$id/reply/$replyId/approval	Edit reply to a Brand Data Point
DELETE	/api/brand-data-points/$id/reply/$replyId/approval	Reject a reply to a Brand Data Point

POST

/api/brand-data-points/$id/like

https://uberall.com/api/brand-data-points/$id/like

Like a Brand Data Point

Like a brand data point

Path parameters

The brand data point id you want to like

DELETE

/api/brand-data-points/$id/like

https://uberall.com/api/brand-data-points/$id/like

Unlike a Brand Data Point

Unlike a brand data point

Path parameters

The brand data point id you want to unlike

PATCH

/api/brand-data-points/$id/reply

https://uberall.com/api/brand-data-points/$id/reply

Reply to a Brand Data Point

Reply with a text to a Brand Data Point, e.g. a review

Path parameters

The uberall unique id of the brand data point you want to reply to

Query Parameters

Required - The text you want to reply, on most directories this will be published and can be read by the author of the original brand data point

POST

/api/brand-data-points/$id/reply/$replyId/approval

https://uberall.com/api/brand-data-points/$id/reply/$replyId/approval

BrandDataPoint

Approve reply to a Brand Data Point

Approves a reply to a brand data point.

Path parameters

The id of the root brand data point.

replyId

The id of the replying brand data point.

PUT

/api/brand-data-points/$id/reply/$replyId/approval

https://uberall.com/api/brand-data-points/$id/reply/$replyId/approval

BrandDataPoint

Edit reply to a Brand Data Point

Editing an existing reply that needs approval to a Brand Data Point

Path parameters

The id of the root brand data point to approve.

replyId

The id of the replying brand data point to approve.

replyText

The edited text of the reply.

DELETE

/api/brand-data-points/$id/reply/$replyId/approval

https://uberall.com/api/brand-data-points/$id/reply/$replyId/approval

BrandDataPoint

Reject a reply to a Brand Data Point

Deletes a reply to a brand data point that needs approval.

Path parameters

The id of the root brand data point.

replyId

The id of the replying brand data point.

Business level connection

POST	/api/business-connections/$directoryType/connect/$businessId	Connect a business
PUT	/api/business-connections/$directoryType/disconnect/$businessId	Disconnect a business
GET	/api/business-connections/$directoryType/sales-partner/$salesPartnerId/count	Count of connections
GET	/api/business-connections/$directoryType/sales-partner/$salesPartnerId/list	List of business connections
GET	/api/business-connections/$directoryType/sales-partner/$salesPartnerId/pages	List of external entities

POST

/api/business-connections/$directoryType/connect/$businessId

https://uberall.com/api/business-connections/$directoryType/connect/$businessId

Connect a business

Creates a business connection between the business and the external entity on directory (e.g. brand page for FB)

Path parameters

businessId

The uberall unique id of the business

directoryType

The type of directory

Body Parameters

accountId

Required - Directory account which will be used for establishing connection

String

connectionId

Additional id that represents the connection, E.G brand pages for Facebook

String

PUT

/api/business-connections/$directoryType/disconnect/$businessId

https://uberall.com/api/business-connections/$directoryType/disconnect/$businessId

Disconnect a business

Deletes or disconnects the current business connection

Path parameters

businessId

The uberall unique id of the business

directoryType

The type of directory

Body Parameters

connectionId

Connection id that must be passed for directories like Twitter

String

deep

Boolean flag indicating whether disconnect should remove all created connections originated from business connect (only applies for Facebook)

String

GET

/api/business-connections/$directoryType/sales-partner/$salesPartnerId/count

https://uberall.com/api/business-connections/$directoryType/sales-partner/$salesPartnerId/count

Count of connections

Get number of all business connections created under given salesPartner

Path parameters

directoryType

The type of directory. e.g. facebook

salesPartnerId

ID of the SalesPartner

Query Parameters

name

filters results by performing search with given value

status

Filter by status

GET

/api/business-connections/$directoryType/sales-partner/$salesPartnerId/list

https://uberall.com/api/business-connections/$directoryType/sales-partner/$salesPartnerId/list

List of business connections

Get detailed list of business connections created under given salesPartner

Path parameters

directoryType

Type of directory. e.g. facebook

salesPartnerId

ID of the SalesPartner

Query Parameters

max

Maximum number of items to return

name

filters results by performing search with given value

offset

Offset used for pagination. Default: 0

status

Required - Filter by status

GET

/api/business-connections/$directoryType/sales-partner/$salesPartnerId/pages

https://uberall.com/api/business-connections/$directoryType/sales-partner/$salesPartnerId/pages

List of external entities

Get list of all the external entities on directories that correspond to all connected accounts on given salesPartner (e.g. brand pages list for FB of all the accounts that have been authenticated under sp)

Path parameters

directoryType

Type of directory

salesPartnerId

ID of Sales Partner

Query Parameters

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

Business Endpoints

GET	/api/businesses	Get a List of Businesses
POST	/api/businesses	Create a Business
POST	/api/businesses/$businessId/locations/sync	Sync All Business's Locations
GET	/api/businesses/$id	Get a Business
PATCH	/api/businesses/$id	Update a Business
DELETE	/api/businesses/$id	Delete a Business
GET	/api/businesses/$id/business-connect/facebook/$facebookAccountId/brand-page-list	Returns only the Facebook brand pages for the given Facebook account
POST	/api/businesses/$id/migrate	Migrate the Business to a new SalesPartner
GET	/api/businesses/statistics	Get Businesses' Statistics

GET

/api/businesses

https://uberall.com/api/businesses

[ Business ,...]

Get a List of Businesses

Get a list of businesses managed by the current user.

Query Parameters

businessIds

Only return businesses identified by ids listed in businessIds

fieldMask

Possible fieldMask options ('id', 'identifier', 'name', 'type', 'streetAndNo', 'addressLine2', 'province', 'zip', 'city','phone', 'country', 'status', 'canSync', 'dateCreated', 'defaultPrice','defaultOriginalPrice', 'defaultPriceSetup', 'productPlan', 'nextProductPlan', 'numOfLocations') eg: fieldMask=type&fieldMask=city

identifier

Only return one business based on your internal identification system

max

Used for pagination. Maximum number of results per page. Default: 10

maxLocations

Only returns businesses with at most maxLocations locations

minLocations

Only return businesses with at least minLocations locations

offset

Offset used for pagination. Default: 0

productPlan

Query accounts by product plan name.

productPlanId

Query accounts by product plan Id.

query

Value used to filter the results by the fields provided in the "queryFields" query parameter. By default, the value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".

queryFields

The fields that will be searched to contain the value provided in the "query" query parameter. The default query fields are "name", "streetAndNo", "zip", "city", "country", "identifier".

sort

The business property to sort by (ascending). One of name, streetAndNo, city, zip, phone

status

Filter by business status. One of ACTIVE, INACTIVE

POST

/api/businesses

https://uberall.com/api/businesses

Business

Create a Business

Create a Business belonging to the SalesPartner of the current User. User needs UserRole ADMIN or ACCOUNT_MANAGER.

Body Parameters

addressLine2

Address extra, e.g. "Suite 123, Third Floor".

String

city

City, where the business is located, e.g. "Berlin".

String

country

Country, where the business is located, e.g. "DE". The country has to be supported by the chosen ProductPlan.

Country

identifier

The business identifier based on your internal identification system, has to be unique inside the SalesPartner. Default value is NULL.

String

name

Required - The name of the business, e.g. "uberall GmbH".

String

phone

Contact phone number, e.g. "+49 (0)30 208 479 320".

String

productPlan

Id of the product plan. Default value is the defaultPlan of the current users SalesPartner.

Integer

province

Province, where the business is located, e.g. "Nordrhein-Westfalen".

String

streetAndNo

Street and street number of the business address, e.g. "Oranienburger Str. 66".

String

type

Business type. One of SMB or ENTERPRISE

Type

zip

Zip code of the business address, e.g. "10117".

String

POST

/api/businesses/$businessId/locations/sync

https://uberall.com/api/businesses/$businessId/locations/sync

Business

Sync All Business's Locations

Start a sync on all directories for all locations in the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Path parameters

businessId

The uberall unique id of the business

GET

/api/businesses/$id

https://uberall.com/api/businesses/$id

Business

Get a Business

Get information about the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Path parameters

The uberall unique id for the business

PATCH

/api/businesses/$id

https://uberall.com/api/businesses/$id

Business

Update a Business

Edit information of the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Path parameters

The uberall unique id of the business you want to edit

Body Parameters

addressLine2

Address extra, e.g. "Suite 123, Third Floor".

String

city

City, where the business is located, e.g. "Berlin".

String

country

Country, where the business is located, e.g. "DE". The country has to be supported by the chosen ProductPlan.

Country

effectiveDate

Date from when the business changes its product plan for the next ProductPlanID (mandatory : set up the next ProductPlanId simultaneously)

String

identifier

The business identifier based on your internal identification system, has to be unique inside the SalesPartner.

String

name

The name of the business, e.g. "uberall GmbH".

String

phone

Contact phone number, e.g. "+49 (0)30 208 479 320".

String

productPlan

The id of the product plan.

Integer

productPlanId

ID of the next product plan applied for the business on the defined effectiveDate (mandatory : set up the effectiveDate simultaneously)

Integer

province

Province, where the business is located, e.g. "Nordrhein-Westfalen".

String

streetAndNo

Street and street number of the business address, e.g. "Oranienburger Str. 66".

String

type

Business type. One of SMB or ENTERPRISE

Type

zip

Zip code of the business address, e.g. "10117".

String

DELETE

/api/businesses/$id

https://uberall.com/api/businesses/$id

Delete a Business

Delete the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER. Locations within the businesses need to be deleted separately.

Path parameters

The uberall unique id for the business you want to the delete

GET

/api/businesses/$id/business-connect/facebook/$facebookAccountId/brand-page-list

https://uberall.com/api/businesses/$id/business-connect/facebook/$facebookAccountId/brand-page-list

Returns only the Facebook brand pages for the given Facebook account

Returns only the Facebook brand pages

Path parameters

facebookAccountId

Unique facebook account id which will be used for locating brand pages

Id of the business that will be used for the search

POST

/api/businesses/$id/migrate

https://uberall.com/api/businesses/$id/migrate

Business

Migrate the Business to a new SalesPartner

Migration is only possible from parent sales partner to child sales partner or between children sales partners.

Path parameters

The uberall unique id of the business you want to migrate

Query Parameters

targetSalesPartnerId

Required - ID of the sales partner where the business should be migrated

targetWhiteLabelIdentifier

If the target sales partner has more then one whitelabel, please specify which one has to be chosen

GET

/api/businesses/statistics

https://uberall.com/api/businesses/statistics

BusinessStatistics

Get Businesses' Statistics

Get statistics about the businesses the current user is managing: total and breakdown by status

Category Endpoints

GET	/api/categories	Get All or Several Categories
GET	/api/categories/$id/attribute-recommendations	Get the recommended attributes for a category
GET	/api/categories/$id/attributes	Get Attributes for a specific Category
GET	/api/categories/$id/available-photo-types	Available photo types by business category.
GET	/api/categories/$id/google-services	Available Google structured services for the location's business category
GET	/api/categories/$id/more-hours-types	Get the supported More Hours for a specific Category

GET

/api/categories

https://uberall.com/api/categories

Get All or Several Categories

Get a list of all available location categories, or specific location categories based on the following parameters

Query Parameters

Get the recommended attributes for a category

Get all Recommended attributes for the Category, Country excluding (already applied attributes on location/payment related attributes) Notes: - Sent to Google and Apple maps - Only the non payment related attributes available and not applied to the location for the primary category of the location can be selected and setup

Path parameters

The Category id

Query Parameters

country

Required - The country to retrieve the attribute recommendations for

keywords

Keywords to look for which are associated with attributes

locationId

Location id to exclude already applied attributes on the provided location

GET

/api/categories/$id/attributes

https://uberall.com/api/categories/$id/attributes

[ AttributeWrapper ,...]

Get Attributes for a specific Category

Get all Attributes for the Category, Country and Language

Notes:
- Sent to Google and Apple maps
- Only the attributes available for the primary category of the location can be selected and setup

Path parameters

The Category id

Query Parameters

country

Required - The country to retrieve the attributes for

language

The language to show the attributes in, this affects only the name of the results

GET

/api/categories/$id/available-photo-types

https://uberall.com/api/categories/$id/available-photo-types

[ String ,...]

Available photo types by business category.

Google limits photo types for each business category. GET a list of available photo types for a category.

Path parameters

Photo types for the location id

GET

/api/categories/$id/google-services

https://uberall.com/api/categories/$id/google-services

[ Map ,...]

Available Google structured services for the location's business category

GET the list of Google's structured services for a location's business category. Google does not have structured services for all business categories.

Path parameters

Category ID for retrieving services

Query Parameters

country

Required - Available structured services vary by country, so a country is needed to provide the available structured services from Google.

language

The language the structured services should be returned in.

GET

/api/categories/$id/more-hours-types

https://uberall.com/api/categories/$id/more-hours-types

[ Map ,...]

Get the supported More Hours for a specific Category

Get all supported More Hours types for a specific Category. Optionally specify language, otherwise default sales partner language is returned

Path parameters

The Category id

Query Parameters

language

The language to show the values in, e.g. 'en' or 'de'.

Collections Endpoints

GET	/api/collections	Get all collections
POST	/api/collections	Create a collection
GET	/api/collections/$id	Get a Collection
PATCH	/api/collections/$id	Update a Collection
DELETE	/api/collections/$id	Delete a Content Collection

GET

/api/collections

https://uberall.com/api/collections

[ ContentCollection ,...]

Get all collections

Get all the collections managed by the current API user.

POST

/api/collections

https://uberall.com/api/collections

ContentCollection

Create a collection

Create a new collection managed by the current API user. If the user specifies a set of locations for the collections, users managing the whole set of locations can also manage the collection.

Body Parameters

A [ ContentCollection ] object.

GET

/api/collections/$id

https://uberall.com/api/collections/$id

ContentCollection

Get a Collection

Retrieve a specific Collection by id

Path parameters

The uberall unique id of the Collection to retrieve

PATCH

/api/collections/$id

https://uberall.com/api/collections/$id

ContentCollection

Update a Collection

Update a specific Collection by id

Path parameters

The uberall unique id of the Collection to update.

Body Parameters

A [ ContentCollection ] object.

DELETE

/api/collections/$id

https://uberall.com/api/collections/$id

ContentCollection

Delete a Content Collection

Delete a specific Collection by id

Path parameters

The uberall unique id of the Collection to delete.

Body Parameters

A [ ContentCollection ] object.

Content list Endpoints

GET	/api/content-lists	Get All Content Lists
POST	/api/content-lists	Create a Content List
GET	/api/content-lists/$id	Get a Content List
PATCH	/api/content-lists/$id	Update a Content List
DELETE	/api/content-lists/$id	Delete a Content List

GET

/api/content-lists

https://uberall.com/api/content-lists

[ ContentList ,...]

Get All Content Lists

Get all content lists managed by the current API user

POST

/api/content-lists

https://uberall.com/api/content-lists

[ ContentList ,...]

Create a Content List

Create a content list

Body Parameters

A [ ContentList ] object.

GET

/api/content-lists/$id

https://uberall.com/api/content-lists/$id

ContentList

Get a Content List

Get a content list identified by its uberall unique id

Path parameters

The uberall unique id of the content list

PATCH

/api/content-lists/$id

https://uberall.com/api/content-lists/$id

ContentList

Update a Content List

Update a content list

Path parameters

The uberall unique id for the content list you want to update

Body Parameters

A [ ContentList ] object.

DELETE

/api/content-lists/$id

https://uberall.com/api/content-lists/$id

Delete a Content List

Delete a content list

Path parameters

The uberall unique id of the content list you want to delete

CrossFeed

GET

/api/crossfeed/locations/$id

Get a Location

GET

/api/crossfeed/locations/$id

https://uberall.com/api/crossfeed/locations/$id

LocationResponse

Get a Location

Path parameters

The id of the location

Query Parameters

fieldMask

A list of fields that you want to retrieve

Custom Item Endpoints

GET	/api/custom-items	Get all Custom Items
POST	/api/custom-items	Create a Custom Item
PATCH	/api/custom-items	Update a Custom Item using identifier
DELETE	/api/custom-items	Delete a Custom Item using identifier
GET	/api/custom-items/$id	Get a Custom Item
PATCH	/api/custom-items/$id	Update a Custom Item
DELETE	/api/custom-items/$id	Delete a Custom Item

GET

/api/custom-items

https://uberall.com/api/custom-items

[ CustomItem ,...]

Get all Custom Items

Get all custom items the current API user can manage.
To specify products with identifier please provide ?identifier= in the url param
By default, 50 are returned, you can use up to max=10000 param

POST

/api/custom-items

https://uberall.com/api/custom-items

CustomItem

Create a Custom Item

Create a custom item. It can be added to a content list later

Body Parameters

A [ CustomItem ] object.

PATCH

/api/custom-items

https://uberall.com/api/custom-items

CustomItem

Update a Custom Item using identifier

Make changes to a custom item, always use ?identifier= in url param to identify the custom item uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

A [ CustomItem ] object.

DELETE

/api/custom-items

https://uberall.com/api/custom-items

Person

Delete a Custom Item using identifier

Delete a custom item identified by identifier in the url param

GET

/api/custom-items/$id

https://uberall.com/api/custom-items/$id

CustomItem

Get a Custom Item

Get a single custom item

Path parameters

The uberall unique id for the custom item

PATCH

/api/custom-items/$id

https://uberall.com/api/custom-items/$id

CustomItem

Update a Custom Item

Make changes to a custom item. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id of the custom item you want to update

Body Parameters

A [ CustomItem ] object.

DELETE

/api/custom-items/$id

https://uberall.com/api/custom-items/$id

CustomItem

Delete a Custom Item

Delete a custom item

Path parameters

The uberall unique id for the custom item you want to delete

Dashboard Export

GET	/api/dashboard-exports	Get a list of dashboard exports
POST	/api/dashboard-exports	Invoke a creation of a dashboard export
GET	/api/dashboard-exports/$id	Get details of a dashboard export by ID
GET	/api/dashboard-exports/$id/download	Download the result of a dashboard export (a PDF file)

GET

/api/dashboard-exports

https://uberall.com/api/dashboard-exports

[ DashboardExportData ,...]

Get a list of dashboard exports

Get a list of dashboard exports.

Query Parameters

locationIds

List of location IDs to filter by

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

POST

/api/dashboard-exports

https://uberall.com/api/dashboard-exports

DashboardExportData

Invoke a creation of a dashboard export

Invoke creation of a dashboard export (in PDF format) asynchronously.

Query Parameters

end

Required - End date of export, in yyyy-MM-dd format

group

Required - Grouping of the historical data

language

Required - Language identifier (i.e. 'fr', 'de')

locationIds

Required - List of location IDs

start

Required - Start date of export, in yyyy-MM-dd format

whitelabelIdentifier

Required - Whitelabel identifier string

GET

/api/dashboard-exports/$id

https://uberall.com/api/dashboard-exports/$id

DashboardExportData

Get details of a dashboard export by ID

Get details of dashboard export by ID.

Path parameters

DashboardExportData Id

GET

/api/dashboard-exports/$id/download

https://uberall.com/api/dashboard-exports/$id/download

File

Download the result of a dashboard export (a PDF file)

Download the result of a dashboard export (a PDF file).

Path parameters

DashboardExportData Id

Dashboard

GET	/api/dashboard/customer-feedback	Get Customer Feedback
GET	/api/dashboard/customer-feedback-by-period	Get Customer Feedback by Period
GET	/api/dashboard/customer-feedback-keywords	Get Customer Feedback Keywords.
GET	/api/dashboard/export-insights-data	Get Insights Export Data
GET	/api/dashboard/export-insights-data-with-threshold	Get Insights Export Data with threshold
GET	/api/dashboard/feed	Get Feed
GET	/api/dashboard/insights-data	Get Insights Data
GET	/api/dashboard/insights-data/warnings	Get Insights Warnings
GET	/api/dashboard/listing-health/$id?	Get Listing Health
GET	/api/dashboard/managers-count/$id	Get Managers Count
GET	/api/dashboard/next-best-actions/$id	Get Next Best Actions
GET	/api/dashboard/profile-completeness	Get Profile Completeness
GET	/api/dashboard/suppressed-duplicates	Get Suppressed Duplicates
GET	/api/dashboard/visibility-index/$id	Get Visibility Index

GET

/api/dashboard/customer-feedback

https://uberall.com/api/dashboard/customer-feedback

CustomerFeedback

Get Customer Feedback

Get the Customer Feedback of the user managed locations filtered by the given ids

Query Parameters

businessIds

The ids of the businesses you want customer feedback for

endDate

The end date

locationIds

The ids of the locations you want customer feedback for

startDate

The start date

textFilter

Filter locations to get customer feedback for by name, zip, street, city, label: e.g. "Berlin"

type

The directory you want customer feedback data for

GET

/api/dashboard/customer-feedback-by-period

https://uberall.com/api/dashboard/customer-feedback-by-period

CustomerFeedbackByPeriod

Get Customer Feedback by Period

Get the Customer Feedback of the user managed locations filtered by the given ids grouped by period

Query Parameters

businessIds

The ids of the businesses you want customer feedback by perdiod for

endDate

The end date

group

How to group the results, one of: DAY, WEEK, MONTH, YEAR

locationIds

The ids of the locations you want customer feedback by period for

startDate

The start date

textFilter

Filter locations to get customer feedback by period for by name, zip, street, city, label: e.g. "Berlin"

type

The directory you want customer feedback by period for

GET

/api/dashboard/customer-feedback-keywords

https://uberall.com/api/dashboard/customer-feedback-keywords

CustomerFeedbackKeywords

Get Customer Feedback Keywords.

Returns the 100 most mentioned Keywords and the average Rating of the Reviews where they appeared.

Query Parameters

businessIds

The ids of the businesses you want to analyze the customer feedback for.

endDate

The end date

locationIds

The ids of the locations you want to analyze the customer feedback for.

startDate

The start date

textFilter

Filter locations to analyze the customer feedback for by name, zip, street, city, label: e.g. "Berlin"

GET

/api/dashboard/export-insights-data

https://uberall.com/api/dashboard/export-insights-data

File

Get Insights Export Data

Get the exported insights data

Query Parameters

businessIds

The ids of the businesses you want to export insights for

endDate

The end date

locationIds

The ids of the locations you want to export insights data for

startDate

The start date

textFilter

Filter locations to export insights for by name, zip, street, city, label: e.g. "Berlin"

GET

/api/dashboard/export-insights-data-with-threshold

https://uberall.com/api/dashboard/export-insights-data-with-threshold

DashboardExportInsightsDataResponse

Get Insights Export Data with threshold

Gets all insights data for the locations. When the request takes too much time, the user will receive the link to the file in an email.

Query Parameters

businessIds

Filter export data by these businessIds

endDate

Filter export data until this date

locationIds

Filter export data by these locationIds

startDate

Filter export data from this date

textFilter

Filter export data by this query. It is applied across these location properties: name, street, streetNo, zip, city, country, identifier, labels

GET

/api/dashboard/feed

https://uberall.com/api/dashboard/feed

[ FeedItem ,...]

Get Feed

Get the Feed of latest activities related to the managed locations

Query Parameters

businessIds

The ids of the businesses you want feed for

dateOffset

Returns data up to this date , default is now

locationIds

The ids of the locations you want feed for

maxItems

Maximum number of items to return

textFilter

Filter locations to get feed for by name, zip, street, city, label: e.g. "Berlin"

GET

/api/dashboard/insights-data

https://uberall.com/api/dashboard/insights-data

[ Insights ,...]

Get Insights Data

Query Parameters

businessIds

The ids of the businesses you want insights data for

endDate

The end date

group

How to group the results, one of: HOUR (only for ACTIONS_PHONE), DAY, WEEK, MONTH or YEAR

locationIds

The ids of the locations you want insights data for

metrics

The types of metrics you want to get. For Google: QUERIES_DIRECT, QUERIES_INDIRECT, VIEWS_MAPS, VIEWS_SEARCH, ACTIONS_WEBSITE, ACTIONS_PHONE, ACTIONS_DRIVING_DIRECTIONS, PHOTOS_VIEWS_MERCHANT, PHOTOS_VIEWS_CUSTOMERS, LOCAL_POST_VIEWS_SEARCH, LOCAL_POST_ACTIONS_CALL_TO_ACTION, BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS / For Facebook: PAGE_IMPRESSIONS, PAGE_CONSUMPTIONS / For Bing: CLICKS_DESKTOP_CORTANA_CALL, CLICKS_DESKTOP_CORTANA_DIRECTIONS, CLICKS_DESKTOP_CORTANA_PHOTOS, CLICKS_DESKTOP_CORTANA_WEBSITE, CLICKS_DESKTOP_MAPS_CALL, CLICKS_DESKTOP_MAPS_DIRECTIONS, CLICKS_DESKTOP_MAPS_PHOTOS, CLICKS_DESKTOP_MAPS_WEBSITE, CLICKS_DESKTOP_SEARCH_PAGE_CALL, CLICKS_DESKTOP_SEARCH_PAGE_DIRECTIONS, CLICKS_DESKTOP_SEARCH_PAGE_PHOTOS, CLICKS_DESKTOP_SEARCH_PAGE_WEBSITE, CLICKS_MOBILE_CORTANA_CALL, CLICKS_MOBILE_CORTANA_DIRECTIONS, CLICKS_MOBILE_CORTANA_PHOTOS, CLICKS_MOBILE_CORTANA_WEBSITE, CLICKS_MOBILE_MAPS_CALL, CLICKS_MOBILE_MAPS_DIRECTIONS, CLICKS_MOBILE_MAPS_PHOTOS, CLICKS_MOBILE_MAPS_WEBSITE, CLICKS_MOBILE_SEARCH_PAGE_CALL, CLICKS_MOBILE_SEARCH_PAGE_DIRECTIONS, CLICKS_MOBILE_SEARCH_PAGE_PHOTOS, CLICKS_MOBILE_SEARCH_PAGE_WEBSITE, IMPRESSIONS_DESKTOP_CORTANA, IMPRESSIONS_DESKTOP_MAPS, IMPRESSIONS_DESKTOP_SEARCH_PAGE, IMPRESSIONS_MOBILE_CORTANA, IMPRESSIONS_MOBILE_MAPS, IMPRESSIONS_MOBILE_SEARCH_PAGE / For Yelp: NUM_CALLS, NUM_DIRECTIONS_AND_MAP_VIEWS, NUM_PAGE_VIEWS, URL_CLICKS

startDate

The start date

textFilter

Filter locations to get insights for by name, zip, street, city, label: e.g. "Berlin"

type

Required. The directory you want insights for. Can be GOOGLE, FACEBOOK, BING or YELP_API

GET

/api/dashboard/insights-data/warnings

https://uberall.com/api/dashboard/insights-data/warnings

UserMissingConnectionWarnings

Get Insights Warnings

Get the Insights warnings. The list of locations/accounts connected/unconnected, which need a user action to be able collecting insights for.

Query Parameters

businessIds

The ids of the businesses you want insights warnings for

locationIds

The ids of the locations you want insights warnings for

max

Used for pagination. Maximum number of results per page

offset

Offset used for pagination. Default: 0

textFilter

Filter locations to get insights warnings for by name, zip, street, city, label: e.g. "Berlin"

type

The directory you want insights warnings for

GET

/api/dashboard/listing-health/$id?

https://uberall.com/api/dashboard/listing-health/$id?

ListingHealth

Get Listing Health

Get the Listing Health for the locations managed by the current user

Path parameters

The id of the location you want the listing health for

Query Parameters

businessIds

The ids of the businesses you want listing health for

locationIds

The ids of the locations you want listing health data for

type

The directory you want listing health data for

GET

/api/dashboard/managers-count/$id

https://uberall.com/api/dashboard/managers-count/$id

LocationManagersCount

Get Managers Count

Get the Managers Count

Path parameters

The id of the location you want the managers count for

GET

/api/dashboard/next-best-actions/$id

https://uberall.com/api/dashboard/next-best-actions/$id

[ LocationTask ,...]

Get Next Best Actions

Get the Next Best Actions recommended to the current user

Path parameters

The id of the location you want the next best actions for

GET

/api/dashboard/profile-completeness

https://uberall.com/api/dashboard/profile-completeness

ProfileCompleteness

Get Profile Completeness

Get the profile completeness of the locations managed by the current user

Query Parameters

businessIds

The ids of the businesses you want profile compliteness data for

locationIds

The ids of the locations you want profile completeness data for

GET

/api/dashboard/suppressed-duplicates

https://uberall.com/api/dashboard/suppressed-duplicates

SuppressedDuplicates

Get Suppressed Duplicates

Get the suppressed duplicates info

Query Parameters

businessIds

The ids of the businesses you want suppressed duplicates data for

endDate

The end date YYYY-MM-DD

locationIds

The ids of the locations you want suppressed duplicates data for

startDate

The start date YYYY-MM-DD

type

The directory you want suppressed duplicates data for

GET

/api/dashboard/visibility-index/$id

https://uberall.com/api/dashboard/visibility-index/$id

VisibilityIndex

Get Visibility Index

Get the Visibility Index of the locations managed by the current user

Path parameters

The id of the location you want the visibility index for

Data Point Endpoints

GET	/api/data-points	Get All Data Points
GET	/api/data-points/$id	Get a Data Point
POST	/api/data-points/$id/flag	Report a Data Point
POST	/api/data-points/$id/like	Like a Data Point
DELETE	/api/data-points/$id/like	Unlike a Data Point
POST	/api/data-points/$id/moderate	Moderate a Data Point
PATCH	/api/data-points/$id/reply	Reply to a Data Point
POST	/api/data-points/$id/reply/$replyId/approval	Approve reply to a Data Point
PUT	/api/data-points/$id/reply/$replyId/approval	Edit reply to a Data Point
DELETE	/api/data-points/$id/reply/$replyId/approval	Reject a reply to a Data Point
GET	/api/data-points/filters	Get available filters for filtering data points
POST	/api/data-points/filters	Create a new saved datapoint's filter
GET	/api/data-points/filters/$id	Get a saved datapoint's filter
PATCH	/api/data-points/filters/$id	Update a saved datapoint's filter
DELETE	/api/data-points/filters/$id	Delete a saved datapoint's filter
POST	/api/data-points/filters/$id/subscription	Subscribe to a saved datapoint's filter
DELETE	/api/data-points/filters/$id/subscription	Unsubscribe from a saved datapoint's filter
GET	/api/data-points/filters/list	List all saved datapoint's filters the user has access
GET	/api/data-points/permissions	List all action datapoint's permissions per directory
POST	/api/data-points/read	Mark as Read
DELETE	/api/data-points/read	Mark as Unread
GET	/api/data-points/statistics	Get Data Points' Statistics
GET	/api/data-points/timeseries	Get Data Points time series

GET

/api/data-points

https://uberall.com/api/data-points

InboxResponse

Get All Data Points

Get all data points, potentially filtered by directory, business, rating...

Query Parameters

businessIds

The ids of the businesses you want data points for

countries

The countries you want data points for. ISO 3166-1 alpha-2 codes

dataPointTypes

The types of data points you want to get: e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

The directories you want data points for

labels

Filter by location labels

locationIds

The ids of the locations you want data points for

max

Used for pagination. Maximum number of results per page

maxActionDate

The max date of the DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

maxThreadActionDate

The max date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

minActionDate

The min date of the DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

minThreadActionDate

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

page

The page number for pagination

query

Filter by name

ratings

Only return inbox items with a rating included in ratings

read

Only show read/not read elements

replied

Only show elements you have/you have not replied to

text

Only return data points with text or without (Boolean)

zip

Only return inbox items for locations where zip starts with given parameter

GET

/api/data-points/$id

https://uberall.com/api/data-points/$id

DataPoint

Get a Data Point

Get information about a single Data Point

Path parameters

The uberall unique id of the data point you want to get

POST

/api/data-points/$id/flag

https://uberall.com/api/data-points/$id/flag

Report a Data Point

Flag a data point on the directory

Path parameters

The uberall unique id of the data point you want to report

Query Parameters

flagType

Required - The flag type supported by the data point's directory. e.g.: [OFFENSIVE, SPAM, NOLONGERRELEVANT, EXTERNAL_URL]

POST

/api/data-points/$id/like

https://uberall.com/api/data-points/$id/like

Like a Data Point

LIke a review (Facebook, Foursquare, ...)

Path parameters

The data point id you want to like

DELETE

/api/data-points/$id/like

https://uberall.com/api/data-points/$id/like

Unlike a Data Point

Unlike a review (Facebook, Foursquare, ...)

Path parameters

The uberall unique id of the data point you want to unlike

POST

/api/data-points/$id/moderate

https://uberall.com/api/data-points/$id/moderate

Moderate a Data Point

Moderate a Data Point. Only Data Points that belong to a WEBSITE_WIDGETS directory can be moderated.

Path parameters

The uberall unique id of the data point you want to moderate

Query Parameters

operation

Required - One of APPROVE or REJECT.

PATCH

/api/data-points/$id/reply

https://uberall.com/api/data-points/$id/reply

Reply to a Data Point

Reply with a text to a Data Point, e.g. a review

Path parameters

The uberall unique id of the data point you want to reply to

Query Parameters

Required - The text you want to reply, on most directories this will be published and can be read by the author of the original data point

POST

/api/data-points/$id/reply/$replyId/approval

https://uberall.com/api/data-points/$id/reply/$replyId/approval

DataPoint

Approve reply to a Data Point

Approves a reply to a data point.

Path parameters

The id of the root data point.

replyId

The id of the replying data point.

PUT

/api/data-points/$id/reply/$replyId/approval

https://uberall.com/api/data-points/$id/reply/$replyId/approval

DataPoint

Edit reply to a Data Point

Editing an existing reply that needs approval to a Data Point

Path parameters

The id of the root data point.

replyId

The id of the replying data point.

replyText

The edited text of the reply.

DELETE

/api/data-points/$id/reply/$replyId/approval

https://uberall.com/api/data-points/$id/reply/$replyId/approval

DataPoint

Reject a reply to a Data Point

Deletes a reply to a data point that needs approval.

Path parameters

The id of the root data point.

replyId

The id of the replying data point.

GET

/api/data-points/filters

https://uberall.com/api/data-points/filters

FiltersResponse

Get available filters for filtering data points

Get available filters for filtering data points, which the current api user has access to.

Query Parameters

locationIds

Applies a filter of locationIds

userId

Shows the filters of the user with this id

POST

/api/data-points/filters

https://uberall.com/api/data-points/filters

Create a new saved datapoint's filter

Creates a new DataPointFilter

Body Parameters

businessIds

List of businessIds to filter the data points by

Set

countries

The list of countries for which the dataPoints should be filtered

Set

dataPointTypes

The list of data point types (REVIEW or PHOTO) for which the dataPoints should be filtered

Set

dateEnd

The maximum date for which the dataPoints should be filtered

DateTime

dateStart

The minimum date for which the dataPoints should be filtered

DateTime

directories

The list of directories for which the dataPoints should be filtered

Set

hasReply

Only include dataPoints you have/you have not replied to

Boolean

hasText

Only include dataPoints which have text

Boolean

isRead

Only include read/not read dataPoints

Boolean

labels

The list of labels for which the dataPoints should be filtered

Set

name

Required - Name of the DataPointFilter

String

query

Any combination of words that should be checked in the dataPoints text, reply messages and author

String

ratings

The list of ratings (1, 2, 3, 4 or 5) for which the dataPoints should be filtered

Set

shared

Defines if the filter is shared or not

Boolean

subscriberIds

The list of businesses IDs for which the dataPoints should be filtered

Set

timeSpan

Predefined time range for filter

DataPointFilterTimeSpan

userId

Required - The user that will be the owner of the filter. Required when request is done as API_ADMIN

Number

GET

/api/data-points/filters/$id

https://uberall.com/api/data-points/filters/$id

DataPointFilter

Get a saved datapoint's filter

The Uberall locationId

Path parameters

ID of a DataPointFilter

Body Parameters

A [ DataPointFilter ] object.

PATCH

/api/data-points/filters/$id

https://uberall.com/api/data-points/filters/$id

DataPointFilter

Update a saved datapoint's filter

Changes a specific DataPointFilter

Path parameters

ID of a DataPointFilter

Body Parameters

A [ DataPointFilter ] object.

DELETE

/api/data-points/filters/$id

https://uberall.com/api/data-points/filters/$id

Delete a saved datapoint's filter

Deletes a specific DataPointFilter

Path parameters

ID of a DataPointFilter

Query Parameters

userId

The user that is the owner of the filter. Required when request is done as API_ADMIN

POST

/api/data-points/filters/$id/subscription

https://uberall.com/api/data-points/filters/$id/subscription

Subscribe to a saved datapoint's filter

Subscribe to a specific DataPointFilter

Path parameters

ID of a DataPointFilter

Query Parameters

userId

ID of a user that should be subscribed to the filter

DELETE

/api/data-points/filters/$id/subscription

https://uberall.com/api/data-points/filters/$id/subscription

Unsubscribe from a saved datapoint's filter

Unsubscribe from a specific DataPointFilter

Path parameters

ID of a DataPointFilter

Query Parameters

userId

ID of a user that should be unsubscribed from the filter

GET

/api/data-points/filters/list

https://uberall.com/api/data-points/filters/list

List all saved datapoint's filters the user has access

Shows owned or subscribed DataPointFilters

Query Parameters

userId

Shows the filters of the user with this id

GET

/api/data-points/permissions

https://uberall.com/api/data-points/permissions

List all action datapoint's permissions per directory

uberDoc.resource.api.data-points.permissions.GET.description

Query Parameters

env

Required - name of the environment - dev, prod, sandbox

POST

/api/data-points/read

https://uberall.com/api/data-points/read

Mark as Read

Mark one or several inbox items as read

Query Parameters

businessIds

Filter by business ids

countries

Filter by countries. ISO 3166-1 alpha-2 codes

dataPointTypes

Filter by type of datapoints. e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

Filter by directories

excludeIds

If selectAll is set to true this parameter can contain a list of data point ids that should not be marked as read

ids

The uberall unique ids for the inbox items you want to mark as read

query

Filter by name

ratings

Only change inbox items with a rating included in ratings

replied

Only change elements you have/you have not replied to

selectAll

Required - If all data points matching the current filter settings should be marked as read

zip

Only change inbox items for locations where zip starts with given parameter

DELETE

/api/data-points/read

https://uberall.com/api/data-points/read

Mark as Unread

Mark one or several inbox items as unread

Query Parameters

businessIds

Filter by business ids

countries

Filter by countries. ISO 3166-1 alpha-2 codes

dataPointTypes

Filter by type of datapoints. e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

Filter by directories

excludeIds

If selectAll is set to true this parameter can contain a list of data point ids that should not be marked as unread

ids

The uberall unique ids for the inbox items you want to mark as unread

query

Filter by name

ratings

Only change inbox items with a rating included in ratings

replied

Only change elements you have/you have not replied to

selectAll

If all data points matching the current filter settings should be marked as unread

zip

Only change inbox items for locations where zip starts with given parameter

GET

/api/data-points/statistics

https://uberall.com/api/data-points/statistics

DatapointStatisticsResponse

Get Data Points' Statistics

Returns statistics about the locations inbox.

Query Parameters

businessIds

Ids of businesses you want inbox statistics for

countries

The countries you want data points' statistics for. ISO 3166-1 alpha-2 codes

dataPointTypes

Types of datapoints you want inbox statistics for. e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

Directories you want inbox statistics for

locationIds

Only consider data points belonging to any of these locationIds

maxActionDate

Only consider data points created before that date

maxThreadActionDate

The max date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

minActionDate

Only consider data points created after that date

minThreadActionDate

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

query

Filter by name

ratings

Ratings of datapoints you want inbox statistics for.

read

(Boolean) Only consider data points that the current user has already read

replied

(Boolean) only consider data points that are either replied or not replied

GET

/api/data-points/timeseries

https://uberall.com/api/data-points/timeseries

DataPointTimeSeriesResponse

Get Data Points time series

Returns time series of Data Points

Query Parameters

businessIds

The ids of the businesses you want Data Pointss time series for

countries

The countries you want Data Points time series for. ISO 3166-1 alpha-2 codes

dataPointTypes

Types of datapoints you want Data Points time series for. e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

The directories you want Data Points time series for

ratings

Only return time series of the Data Points with a rating included in ratings

read

Only include read/not read elements

replied

Only include elements you have/you have not replied to

zip

Only return Data Points time series for locations where zip starts with given parameter

Directories Endpoints

GET

/api/directories/directories-details/countries

Get All Directories details by country

GET

/api/directories/directories-details/countries

https://uberall.com/api/directories/directories-details/countries

[ DirectoriesDetailsCountry ,...]

Get All Directories details by country

Returns a list of directories details filtered by country

Query Parameters

countries

Optional list parameter of comma separated ISO 3166 alpha-2 country codes to filter response (e.g. US,DE)

Directory Brands Endpoints

GET	/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType	Get All Directory Brands
POST	/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType	Create Directory Brand
PUT	/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/brands/$brandExternalId/$directoryType	Update Directory Brand

GET

/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType

https://uberall.com/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType

DirectoryBrandPageResponse

Get All Directory Brands

Returns a list of directory brands for the given account and directory

Path parameters

accountId

DirectoryUserAccount Id

directoryType

Type of directory

salesPartnerId

sales partner id

POST

/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType

https://uberall.com/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/$directoryType

DirectoryBrand

Create Directory Brand

Create directory brand for the given sales partner id, directory user account and directory type

Path parameters

accountId

DirectoryUserAccount Id

directoryType

Type of directory

salesPartnerId

Sales Partner Id

Body Parameters

A [ DirectoryBrand ] object.

PUT

/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/brands/$brandExternalId/$directoryType

https://uberall.com/api/directory-brand/sales-partner/$salesPartnerId/user-account/$accountId/brands/$brandExternalId/$directoryType

DirectoryBrand

Update Directory Brand

Update directory brand for the given sales partner id, directory user account, external brand id and directory type

Path parameters

accountId

DirectoryUserAccount Id

brandExternalId

External Directory Brand Id

directoryType

Directory Type

salesPartnerId

Sales Partner Id

Body Parameters

A [ DirectoryBrand ] object.

Event Endpoints

GET	/api/events	Get All Events
POST	/api/events	Create an Event
PATCH	/api/events	Update an Event using identifier
DELETE	/api/events	Delete an Event using identifier
GET	/api/events/$id	Get an Event
PATCH	/api/events/$id	Update an Event
DELETE	/api/events/$id	Delete an Event

GET

/api/events

https://uberall.com/api/events

[ Event ,...]

Get All Events

Get all events the current API user can manage.
To specify events with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 in the URL param

POST

/api/events

https://uberall.com/api/events

Event

Create an Event

Create a new event. It can be added to a content list later

Body Parameters

A [ Event ] object.

PATCH

/api/events

https://uberall.com/api/events

Event

Update an Event using identifier

Make changes to an event, always use ?identifier= in url param to identify the event uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

A [ Event ] object.

DELETE

/api/events

https://uberall.com/api/events

Delete an Event using identifier

Delete an event identified by identifier in the url param

GET

/api/events/$id

https://uberall.com/api/events/$id

Event

Get an Event

Get a single event identified by its uberall unique id

Path parameters

The uberall unique id for the event

PATCH

/api/events/$id

https://uberall.com/api/events/$id

Event

Update an Event

Make changes to an event. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id of the event you want to update

Body Parameters

A [ Event ] object.

DELETE

/api/events/$id

https://uberall.com/api/events/$id

Delete an Event

Delete an event

Path parameters

The uberall unique id for the event you want to delete

Features Endpoint

GET

/api/features

Get user features

GET

/api/features

https://uberall.com/api/features

FeaturesResponse

Get user features

Get user features partitioned by location.

Homepage

GET	/api/homepage/cards	Get the Homepage cards for the user
GET	/api/homepage/customer-feedback	Get Customer Feedback information for all locations.
GET	/api/homepage/customer-feedback-keywords	Get Customer Feedback Keyword information for all locations
GET	/api/homepage/customer-feedback-keywords/$id	Get Customer Feedback Keyword information for a single location
GET	/api/homepage/customer-feedback/$id	Get Customer Feedback information for a single location.
GET	/api/homepage/header	Get Header information for all locations
GET	/api/homepage/header/$id	Get Header information for a single location
GET	/api/homepage/insights	Get Insights information for all locations
GET	/api/homepage/insights/$id	Get Insights information for a single location
GET	/api/homepage/interactions	Get Interactions information for all locations
GET	/api/homepage/interactions/$id	Get Interactions information for a single location
GET	/api/homepage/listing-health	Get Listing Health information for all locations
GET	/api/homepage/listing-health/$id	Get Listing Health information for a single location
GET	/api/homepage/profile-completeness	Get Profile Completeness information for all locations
GET	/api/homepage/profile-completeness/$id	Get Profile Completeness information for a single location
GET	/api/homepage/search-rank	Get Search Rank information for all locations
GET	/api/homepage/search-rank/$id	Get Search Rank information for a single location
GET	/api/homepage/social-post-metrics	Get Social Post Metrics information for all locations
GET	/api/homepage/social-post-metrics/$id	Get Social Post Metrics information for a single location
GET	/api/homepage/store-locator	Get Store Locator information for all locations
GET	/api/homepage/store-locator/$id	Get Store Locator information for a single location
GET	/api/homepage/todos	Get Todos for all locations
GET	/api/homepage/todos/$id	Get Todos for a single location

GET

/api/homepage/cards

https://uberall.com/api/homepage/cards

CardsHomepageResponse

Get the Homepage cards for the user

Get the Homepage cards a given user has access to

GET

/api/homepage/customer-feedback

https://uberall.com/api/homepage/customer-feedback

CustomerFeedbackMultiLocationHomepageResponse

Get Customer Feedback information for all locations.

Get Customer Feedback information for all locations. Populates the cards 'average-rating', 'rating-split', 'reply-rate', 'reply-rate-split'.

GET

/api/homepage/customer-feedback-keywords

https://uberall.com/api/homepage/customer-feedback-keywords

CustomerFeedbackKeywordsHomepageResponse

Get Customer Feedback Keyword information for all locations

Get Customer Feedback Keywords information for all locations. Populates the card 'review-sentiment'.

GET

/api/homepage/customer-feedback-keywords/$id

https://uberall.com/api/homepage/customer-feedback-keywords/$id

CustomerFeedbackKeywordsHomepageResponse

Get Customer Feedback Keyword information for a single location

Get Customer Feedback Keywords information for a single location. Populates the card 'review-sentiment'.

Path parameters

The Uberall locationId

GET

/api/homepage/customer-feedback/$id

https://uberall.com/api/homepage/customer-feedback/$id

CustomerFeedbackSingleLocationHomepageResponse

Get Customer Feedback information for a single location.

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/header

https://uberall.com/api/homepage/header

HeaderMultiLocationHomepageResponse

Get Header information for all locations

Query Parameters

language

Language for translations (en, de, fr, it, es, ...)

GET

/api/homepage/header/$id

https://uberall.com/api/homepage/header/$id

HeaderSingleLocationHomepageResponse

Get Header information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/insights

https://uberall.com/api/homepage/insights

InsightsDataMultiLocationHomepageResponse

Get Insights information for all locations

Get Insights information for all locations. Populates the cards 'google-impressions', 'google-indirect-search-queries', 'google-direct-search-queries', 'google-conversions', 'google-conversions-lowest', 'google-conversions-highest' and 'google-photos'.

Query Parameters

language

Language for translations (en, de, fr, it, es, ...)

GET

/api/homepage/insights/$id

https://uberall.com/api/homepage/insights/$id

InsightsDataSingleLocationHomepageResponse

Get Insights information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

Query Parameters

language

Language for translations (en, de, fr, it, es, ...)

GET

/api/homepage/interactions

https://uberall.com/api/homepage/interactions

InteractionsHomepageResponse

Get Interactions information for all locations

Get Interactions information for all locations. Populates the card 'interactions'.

Query Parameters

directoryTypes

Directory types to filter (Google, Facebook)

GET

/api/homepage/interactions/$id

https://uberall.com/api/homepage/interactions/$id

InteractionsHomepageResponse

Get Interactions information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

Query Parameters

directoryTypes

Directory types to filter (Google, Facebook)

GET

/api/homepage/listing-health

https://uberall.com/api/homepage/listing-health

ListingHealthMultiLocationHomepageResponse

Get Listing Health information for all locations

Get Listing Health information for all locations. Populates the card 'listings'.

GET

/api/homepage/listing-health/$id

https://uberall.com/api/homepage/listing-health/$id

ListingHealthSingleLocationHomepageResponse

Get Listing Health information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/profile-completeness

https://uberall.com/api/homepage/profile-completeness

ProfileCompletenessMultiLocationHomepageResponse

Get Profile Completeness information for all locations

Get Profile Completeness information for all locations. Populates the card 'profile-completeness'.

GET

/api/homepage/profile-completeness/$id

https://uberall.com/api/homepage/profile-completeness/$id

ProfileCompletenessSingleLocationHomepageResponse

Get Profile Completeness information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/search-rank

https://uberall.com/api/homepage/search-rank

SearchRanksMultiLocationHomepageResponse

Get Search Rank information for all locations

Get Search Rank information for all locations. Populates the cards 'google-direct-search-rank' and 'google-discovery-search-rank'.

GET

/api/homepage/search-rank/$id

https://uberall.com/api/homepage/search-rank/$id

SearchRanksSingleLocationHomepageResponse

Get Search Rank information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/social-post-metrics

https://uberall.com/api/homepage/social-post-metrics

SocialPostMetricsHomepageResponse

Get Social Post Metrics information for all locations

Get Social Post Metrics information for all locations. Populates the card 'facebook-posts'.

Query Parameters

directoryTypes

Directory types to filter (Google, Facebook)

GET

/api/homepage/social-post-metrics/$id

https://uberall.com/api/homepage/social-post-metrics/$id

SocialPostMetricsHomepageResponse

Get Social Post Metrics information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

Query Parameters

directoryTypes

Directory types to filter (Google, Facebook)

GET

/api/homepage/store-locator

https://uberall.com/api/homepage/store-locator

StoreFinderEventsHomepageResponse

Get Store Locator information for all locations

Get Store Locator information for all locations. Populates the card 'storelocator'.

GET

/api/homepage/store-locator/$id

https://uberall.com/api/homepage/store-locator/$id

StoreFinderEventsHomepageResponse

Get Store Locator information for a single location

The Uberall locationId

Path parameters

The Uberall locationId

GET

/api/homepage/todos

https://uberall.com/api/homepage/todos

TodosHomepageResponse

Get Todos for all locations

Get Todos information (recommended actions to the user) for all locations

GET

/api/homepage/todos/$id

https://uberall.com/api/homepage/todos/$id

TodosHomepageResponse

Get Todos for a single location

The Uberall locationId

Path parameters

The Uberall locationId

Labels Endpoints

GET

/api/labels

Get All Labels

GET

/api/labels

https://uberall.com/api/labels

[ Label ,...]

Get All Labels

Get all labels associated to locations of the user

Listing Endpoints

PATCH	/api/listings/$id	Edit Listing
PUT	/api/listings/$id/flag	Flag a Listing

PATCH

/api/listings/$id

https://uberall.com/api/listings/$id

Listing

Edit Listing

Used for MANUALLY_CREATED listings to update listingUrl and syncStatus

Path parameters

The Id of the MANUALLY_CREATED listing to be updated

PUT

/api/listings/$id/flag

https://uberall.com/api/listings/$id/flag

Listing

Flag a Listing

Flag a listing if it is not corresponding to the right location

Path parameters

The uberall unique id for the listing you want to flag

Location Groups

GET	/api/location-groups	Search through all LocationGroups
POST	/api/location-groups	Create a new LocationGroup
GET	/api/location-groups/$id	Get a single LocationGroup
PATCH	/api/location-groups/$id	Update a single LocationGroup
DELETE	/api/location-groups/$id	Delete a single LocationGroup

GET

/api/location-groups

https://uberall.com/api/location-groups

[ LocationGroupListResponse ,...]

Search through all LocationGroups

Can be used to search for specific location groups or even return all, depending on the given params.

Query Parameters

fieldMask

Used for bypassing pagination and reducing the response objects (List of String), following are supported ["id", "name"]

hideLocations

if given true value the endpoint will not return the locations array as part of the response, just the group id and name

locationGroupIds

Used for restricting the to be returned location groups within the given range of IDs (Long).

max

Used for pagination, specifies the amount (Integer) of entries maximum returned per page (must be between 0-100).

offset

Used for pagination, specifies the starting point (Integer) from which the returned subset should start.

order

Used for specify the sorting direction (String) in which the list entries shall be returned, possible values ["ASC", "DESC"].

page

Used for pagination, specifies which page (Integer) you want to get back from a set of pages. Can be used instead of using "offset". Can also be used in combination with "max" otherwise default "max" is being used. Difference to "offset" is that you don't need to calculate the correct value, you can simply request page number 2 with max 10 result in it (page: 2, max: 10). So you will get back results 10-19 while skipping the first 10 (0-9) ones.

query

Used for searching for a specific keyword (String) within the location group names, only groups matching the given query via "like" will be returned.

sort

Used for specify the field (String) by which the list entries shall be sorted, possible values ["NAME", "LAST_UPDATED", "LOCATION_SIZE", "USER_SIZE"]. If none or invalid given list will automatically sorted by "id".

POST

/api/location-groups

https://uberall.com/api/location-groups

LocationGroup

Create a new LocationGroup

Can be used to create a new LocationGroup

Body Parameters

locations

List of location IDs (Long) that shall be assigned to the new LocationGroup.

List

name

Required - Name (String) of the LocationGroup

String

status

Status of the LocationGroup, defaults to "ACTIVE", supported values: ["ACTIVE"].

Status

users

List of user IDs (Long) that shall be assigned to the new LocationGroup.

List

GET

/api/location-groups/$id

https://uberall.com/api/location-groups/$id

LocationGroup

Get a single LocationGroup

Can be used to retrieve a single LocationGroup.

Path parameters

ID (Long) of the LocationGroup that should be returned.

PATCH

/api/location-groups/$id

https://uberall.com/api/location-groups/$id

LocationGroup

Update a single LocationGroup

Can be used for updating a single LocationGroup.

Path parameters

ID (Long) of the LocationGroup that should be updated.

Body Parameters

locations

List of location IDs (Long) that shall be assigned to the new LocationGroup. For clearing this field you can send either null or an empty list [].

List

name

Name (String) of the LocationGroup.

String

status

Status of the LocationGroup, defaults to "ACTIVE", supported values: ["ACTIVE"].

Status

users

List of user IDs (Long) that shall be assigned to the new LocationGroup. For clearing this field you can send either null or an empty list [].

List

DELETE

/api/location-groups/$id

https://uberall.com/api/location-groups/$id

LocationGroup

Delete a single LocationGroup

Can be used for deleting a single LocationGroup.

Path parameters

ID (Long) of the LocationGroup that should be deleted.

Location Endpoints

GET	/api/locations	Get Several Locations
POST	/api/locations	Create a Location
PATCH	/api/locations	Update Several Locations
DELETE	/api/locations	Delete Several Locations
GET	/api/locations/$id	Get a Location
PATCH	/api/locations/$id	Update a Location
GET	/api/locations/$id/dashboard	Get a Location's Dashboard
GET	/api/locations/$id/datapoints	DEPRECATED - Get Location's Data Points
GET	/api/locations/$id/datapoints/statistics	DEPRECATED - Get Location's Data Point Statistics
GET	/api/locations/$id/facebook/page	Get Location's Facebook Page
POST	/api/locations/$id/facebook/page	DEPRECATED - Connect Facebook Page
DELETE	/api/locations/$id/facebook/page	Disconnect Location's Facebook Page
GET	/api/locations/$id/google/page	Get information about the connected Google Page of the specified location
DELETE	/api/locations/$id/google/page	Disconnect Google Page
DELETE	/api/locations/$id/instagram/page	Disconnect Instagram Page
GET	/api/locations/$id/listings-details/list	Get all Listings for a specific Location
GET	/api/locations/$id/logging-events	Get Logging Events
GET	/api/locations/$id/suggestions	Get suggestions
PUT	/api/locations/$id/suggestions	Update suggestions
POST	/api/locations/$id/sync	Sync a Location
GET	/api/locations/$id/visibility-indexes	Get Location's Visibility Index
GET	/api/locations/$id/visibility-indexes/interesting	Get Historical Visibility Index
PATCH	/api/locations/$locationId/ev-data/$uid	Update EV Charging Data
GET	/api/locations/$locationId/profile-completeness	Get Location's Profile Completeness
GET	/api/locations/available-lodging-fields	Get the available amenities (Google Lodging) fields for a location
GET	/api/locations/cities	Get the city for locations
GET	/api/locations/countries	Get the country for locations
GET	/api/locations/directories	Get the directories for locations
GET	/api/locations/keywords	Get the keywords for locations
GET	/api/locations/labels	Get the labels for locations
GET	/api/locations/postcodes	Get the post / zip code for locations
GET	/api/locations/provinces	Get the province/state for locations
GET	/api/locations/statistics	Get Locations' Statistics
GET	/api/locations/suggestions	Get Location Suggestions
POST	/api/locations/sync	Sync Several Locations
GET	/api/locations/tracking-events	Get Tracking Events

GET

/api/locations

https://uberall.com/api/locations

[ LocationSearchResult ,...]

Get Several 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

Only return locations in the business identified by businessId. Allowed multiple businessIds such as /api/locations?businessId=123&businessId=456

businessIds

Returns all locations associated with multiple business ids

cities

Get locations in the requested cities

classification

Possible values: REQUIRED, BASIC, ADVANCED, BONUS and COMPLETE

countries

Get locations in the requested country

endDateMax

Only locations with an endDate less than or equal to endDateMax will be returned. e.g. 2020-02-05T12:18:12.000+01:00

endDateMin

Only locations with an endDate greater than or equal to endDateMin will be returned. e.g. 2018-02-05T12:18:12.000+01:00

excludedLocationIds

List of locationIds that should be excluded from the result. eg: excludedLocationIds=20&excludedLocationIds=21 for multiple locations

facebookStatus

Possible values: CONNECTED, NOT_CONNECTED

fieldMask

Possible fieldMask options ( 'id', 'name', 'identifier', 'street', 'streetNo', 'streetAndNumber', 'addressExtra', 'zip', 'city', 'province', 'lat', 'lng', 'addressDisplay', 'phone', 'fax', 'cellPhone', 'website', 'email', 'legalIdent', 'taxNumber', 'descriptionShort', 'descriptionLong', 'imprint', 'openingHoursNotes', 'status','firstSyncStarted', 'lastSyncStarted', 'autoSync', 'locationSyncable', 'businessId', 'googleInsights', 'labels') eg: fieldMask=city&fieldMask=zip

googleStatus

Possible values: VERIFIED (the Google listing is verified and fully managed by us), VERIFICATION_STARTED (a verification pin has been requested for the Google listing), VERIFICATION_NOT_STARTED (the verification process has not been start for the Google listing), NOT_CONNECTED (there is no Google account connected for the listing), VERIFIED_BY_THIRD_PARTY (there is a verified listing on Google but we do not manage it)

groupIds

The groupId to which the location belongs

groups

The name of the group to which the location belongs

identifier

Only return one location (per business) based on your internal identification system

labels

Only return locations that contain at least one of the given labels

locationIds

Only return locations identified by ids listed in locationIds, e.g.:

...?locationIds=20&locationIds=22 for multiple locations

max

Used for pagination. Maximum number of results per page. Default: 50 (Without a defined FieldMask the maximum number of results is 50.)

missingDirectoryField

Only return locations that have no value for the given field

needsReview

If set to true, only return locations with faulty data in need of review. Default: false.

offset

Offset used for pagination. Default: 0

order

use asc for ascending sort or desc for descending sort

postcodes

Get locations in the requested post / zip codes

provinces

Get locations in the requested province / state

query

Filter by name, zip, street, city, label: e.g. "Berlin"

queryFields

The fields that will be searched to contain the value provided in the "query" query parameter.

selectAll

Setting selectAll to true allows finding ALL locations for any given businessId, locationIds and labels. In other words these fields are OR joined.

sort

The location property to sort by (ascending unless order is specified). One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country

status

Filter by locations status. One of ACTIVE, INACTIVE, CANCELLED

syncNeeded

If set to true, filter locations that have been updated but did not start a sync yet

syncStarted

If set to true, filter locations that started a sync. If set to false, filter locations that never synced

POST

/api/locations

https://uberall.com/api/locations

Location

Create a Location

Create a location and add it to an existing business

Body Parameters

A [ Location ] object.

PATCH

/api/locations

https://uberall.com/api/locations

Update Several Locations

Make changes to a list of locations. Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

locations

Required - List of Maps with both location id and params to update : [{id: 123, status: CANCELLED}, ...]

List

DELETE

/api/locations

https://uberall.com/api/locations

Delete Several Locations

Delete several locations identified by their uberall unique ids. Locations can be deleted only if they are inactivated (status = INACTIVE) and are no longer billed (endDate < now).

Query Parameters

locations

Required - The uberall unique ids for the locations you want to delete

GET

/api/locations/$id

https://uberall.com/api/locations/$id

LocationResponse

Get a Location

Get all information about a specific location, including listing statuses

Path parameters

The uberall unique id of the location

PATCH

/api/locations/$id

https://uberall.com/api/locations/$id

Location

Update a Location

Make changes to a location. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id for the location you want to update

Body Parameters

A [ Location ] object.

GET

/api/locations/$id/dashboard

https://uberall.com/api/locations/$id/dashboard

LocationDashboardResponse

Get a Location's Dashboard

Get all necessary information to build a location's dashboard

Path parameters

The uberall unique id of the location you want a dashboard for

GET

/api/locations/$id/datapoints

https://uberall.com/api/locations/$id/datapoints

InboxResponse

DEPRECATED - Get Location's Data Points

Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points-GET instead.

Path parameters

The uberall unique id of the location you want inbox items for

GET

/api/locations/$id/datapoints/statistics

https://uberall.com/api/locations/$id/datapoints/statistics

DatapointStatisticsResponse

DEPRECATED - Get Location's Data Point Statistics

Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points_statistics-GET instead.

Path parameters

The uberall unique id of the location.

Query Parameters

dataPointTypes

Types of datapoints you want inbox statistics for. e.g. [PHOTO, REVIEW, CHECKIN]

directoryTypes

Directories you want inbox statistics for.

maxActionDate

Only consider data points created before that date

maxThreadActionDate

The max date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

minActionDate

Only consider data points created after that date

minThreadActionDate

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds, e.g. 1514764800000

ratings

Ratings of datapoints you want inbox statistics for.

GET

/api/locations/$id/facebook/page

https://uberall.com/api/locations/$id/facebook/page

DirectoryPage

Get Location's Facebook Page

Get the Facebook page connected to a specific location

Path parameters

The uberall unique id of the location you want the Facebook page for

POST

/api/locations/$id/facebook/page

https://uberall.com/api/locations/$id/facebook/page

DirectoryPage

DEPRECATED - Connect Facebook Page

Connect a Facebook page to the location

Path parameters

The uberall unique id for the location

Query Parameters

fb_access_token

A Facebook API access token with "manage_pages", "publish_actions" and "read_page_mailboxes" permissions

pageId

The Facebook unique id of the page you want to connect

DELETE

/api/locations/$id/facebook/page

https://uberall.com/api/locations/$id/facebook/page

Disconnect Location's Facebook Page

Disconnect the Facebook page connected to a specific location

Path parameters

The uberall unique id of the location

GET

/api/locations/$id/google/page

https://uberall.com/api/locations/$id/google/page

DirectoryListingPage

Get information about the connected Google Page of the specified location

Get information such as Google place id, write review URL, etc.

Path parameters

The uberall unique id of the location

DELETE

/api/locations/$id/google/page

https://uberall.com/api/locations/$id/google/page

Disconnect Google Page

Disconnect the Google Page connected to the specified location

Path parameters

The uberall unique id of the location

DELETE

/api/locations/$id/instagram/page

https://uberall.com/api/locations/$id/instagram/page

Disconnect Instagram Page

Disconnect the Instagram Page connected to the specified location

Path parameters

The uberall unique id of the location

GET

/api/locations/$id/listings-details/list

https://uberall.com/api/locations/$id/listings-details/list

ListingsDetailsResponse

Get all Listings for a specific Location

Lists all the details of all Listings for a specific Location

Path parameters

The uberall unique id of the location

GET

/api/locations/$id/logging-events

https://uberall.com/api/locations/$id/logging-events

[ LoggingEvent ,...]

Get Logging Events

Get logging events (e.g. sync, changes, normalization...) for a specific location

Path parameters

The uberall unique id for the location

Query Parameters

from

The start of the time range to retrieve logging events for. Unix timestamp in milliseconds

The end of the time range to retrieve logging events for. Unix timestamp in milliseconds

GET

/api/locations/$id/suggestions

https://uberall.com/api/locations/$id/suggestions

[ SuggestionResponse ,...]

Get suggestions

Get location suggestions given a search data

Path parameters

The uberall unique id for the location

Query Parameters

directoryTypes

Filter suggestions by directories

language

Filter suggestion attributes by language

PUT

/api/locations/$id/suggestions

https://uberall.com/api/locations/$id/suggestions

[ Suggestion ,...]

Update suggestions

Update the given suggestion object, used to track the status of incoming suggestions. Note that rejecting a suggestion does not delete it, and accepting the suggestion won't automatically apply it to the location.

Path parameters

The uberall unique id for the suggestion

Body Parameters

suggestions

Required - List of Maps with both an id and a status key: [[id: 123, status: ACCEPTED], ...]

List

POST

/api/locations/$id/sync

https://uberall.com/api/locations/$id/sync

Sync a Location

Start a sync on all directories for a specific location

Path parameters

The uberall unique id for the location you want to sync

GET

/api/locations/$id/visibility-indexes

https://uberall.com/api/locations/$id/visibility-indexes

VisibilityIndex

Get Location's Visibility Index

Get the latest location's visibility index

Path parameters

The uberall unique id for the location

Query Parameters

days

Use days to get the visibility index from as many days ago

GET

/api/locations/$id/visibility-indexes/interesting

https://uberall.com/api/locations/$id/visibility-indexes/interesting

[ VisibilityIndex ,...]

Get Historical Visibility Index

Get a Visibility Index time series. Only days where the Visibility Index changed will be returned

Path parameters

The uberall unique id of the location you want the Visibility Index for

Query Parameters

endDate

endDate in YYYY-MM-dd

startDate

startDate in YYYY-MM-dd

PATCH

/api/locations/$locationId/ev-data/$uid

https://uberall.com/api/locations/$locationId/ev-data/$uid

Update EV Charging Data

Update EV Charging data for a given EV Charging Station.

Path parameters

locationId

The uberall unique id of the EV Charging station for which you want to update information.

uid

The UID for the EV Charging station

Query Parameters

status

Required - Query based on the location status

Body Parameters

A [ EvStatus ] object.

GET

/api/locations/$locationId/profile-completeness

https://uberall.com/api/locations/$locationId/profile-completeness

LocationProfileCompleteness

Get Location's Profile Completeness

Get the current classification and information for each field if it is filled out. Classification can be one of 'Required', 'Bonus', 'Advanced', 'Bonus' or 'Complete'.

Path parameters

locationId

The uberall unique id for the location

GET

/api/locations/available-lodging-fields

https://uberall.com/api/locations/available-lodging-fields

[ LodgingField ,...]

Get the available amenities (Google Lodging) fields for a location

Get the list of all available amenities (Google Lodging) fields.

GET

/api/locations/cities

https://uberall.com/api/locations/cities

Get the city for locations

Get the location's city

Query Parameters

businessIds

Get the cities for locations by business id

countries

Get the cities for locations by country

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

provinces

Get the cities for locations by province / state

query

Restricts the response to the cities that contain this text, for example "ber" would return "Berlin" when appropriate.

GET

/api/locations/countries

https://uberall.com/api/locations/countries

Get the country for locations

Get the country for each location

Query Parameters

businessIds

Required - The business ids for the locations that should be returned

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

GET

/api/locations/directories

https://uberall.com/api/locations/directories

Get the directories for locations

Get the directories for a location

GET

/api/locations/keywords

https://uberall.com/api/locations/keywords

List

Get the keywords for locations

Body Parameters

businessIds

Required - The business ids for the locations that should be returned

List

excludedLocationIds

Required - List of location ids which should be excluded from keywords search

List

locationIds

Required - The location ids that should have keywords returned

List

GET

/api/locations/labels

https://uberall.com/api/locations/labels

Get the labels for locations

Get the labels assigned to a location

GET

/api/locations/postcodes

https://uberall.com/api/locations/postcodes

Get the post / zip code for locations

Get the post / zip code assigned to a location

Query Parameters

businessIds

Get the post / zip codes for locations assigned to a business id

cities

Get the post / zip codes for locations within a city

countries

Get the post / zip codes for locations within a country

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

provinces

Get the post / zip codes for locations within a province / state

query

Restricts the response to the post/zip codes that contain this text, for example "374" would return "37490" when appropriate.

GET

/api/locations/provinces

https://uberall.com/api/locations/provinces

Get the province/state for locations

Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

Query Parameters

businessIds

Get the provinces / states of locations associated with specific Business Id(s)

countries

Get provinces / states for locations in a country

max

Maximum number of items to return

offset

Offset used for pagination. Default: 0

query

Restricts the response to the provinces/states that contain this text, for example "indi" would return "Indiana" when appropriate.

GET

/api/locations/statistics

https://uberall.com/api/locations/statistics

LocationStatisticsResponse

Get Locations' Statistics

Get statistics about the locations the current user is managing: total and breakdown by status

GET

/api/locations/suggestions

https://uberall.com/api/locations/suggestions

SuggestionResponse

Get Location Suggestions

Get a list of suggestions for all locations managed by the logged user

Query Parameters

businessId

The ids of the businesses you want suggestions for

identifier

The location identifier, based on your internal identification system, you want the suggestions for.

locationIds

The ids of the locations you want suggestions for.

max

Used for pagination. Maximum number of results per page.

offset

Offset used for pagination. Default: 0

order

use asc for ascending sort or desc for descending sort

query

Filter by name, zip, street, city, label: e.g. "Berlin"

sort

The location property to sort by (ascending unless order is specified). One of name, street, streetNo, zip, city, phone, cellphone, fax, website, email, lastSyncStarted, country

POST

/api/locations/sync

https://uberall.com/api/locations/sync

Sync Several Locations

Start a sync on all directories for several locations identified by their unique uberall id

Query Parameters

locationIds

Required - The uberall unique ids for the locations you want to sync

GET

/api/locations/tracking-events

https://uberall.com/api/locations/tracking-events

LocationStatisticsResponse

Get Tracking Events

Returns a list of tracking events for all locations managed by the logged user

Query Parameters

max

Used for pagination. Maximum number of results per page. Default: 10

offset

Offset used for pagination. Default: 0

GET	/api/menu-items	Get All Menu Items
POST	/api/menu-items	Create a Menu Item
PATCH	/api/menu-items	Update a Menu Item using identifier
DELETE	/api/menu-items	Delete a Menu Item using identifier
GET	/api/menu-items/$id	Get a Menu Item
PATCH	/api/menu-items/$id	Update a Menu Item
DELETE	/api/menu-items/$id	Delete a Menu Item
GET	/api/menu-items/accepted-extra-fields	Get accepted values for dietary restrictions and allergens

GET

/api/menu-items

https://uberall.com/api/menu-items

[ MenuItem ,...]

Get All Menu Items

Get all menu items the current API user can manage.
To specify products with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 in the URL param

POST

/api/menu-items

https://uberall.com/api/menu-items

MenuItem

Create a Menu Item

Create a menu item. It can be added to a content list later

Body Parameters

A [ MenuItem ] object.

PATCH

/api/menu-items

https://uberall.com/api/menu-items

MenuItem

Update a Menu Item using identifier

Make changes to a menu item, always use ?identifier= in url param to identify the menu item uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

A [ MenuItem ] object.

DELETE

/api/menu-items

https://uberall.com/api/menu-items

Delete a Menu Item using identifier

Delete a menu item identified by identifier in the url param

GET

/api/menu-items/$id

https://uberall.com/api/menu-items/$id

MenuItem

Get a Menu Item

Get a sigle menu item

Path parameters

The uberall unique id for the menu item

PATCH

/api/menu-items/$id

https://uberall.com/api/menu-items/$id

MenuItem

Update a Menu Item

Make changes to a menu item. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id of the menu item you want to update

Body Parameters

A [ MenuItem ] object.

DELETE

/api/menu-items/$id

https://uberall.com/api/menu-items/$id

Delete a Menu Item

Delete a menu item

Path parameters

The uberall unique id for the menu item you want to delete

GET

/api/menu-items/accepted-extra-fields

https://uberall.com/api/menu-items/accepted-extra-fields

Map

Get accepted values for dietary restrictions and allergens

Menu items can have additional information added to them. Certain fields are limited to specific values. Get the list of values here.

API Status Endpoints

GET

/api/monitoring/ping

Get API Status

GET

/api/monitoring/ping

https://uberall.com/api/monitoring/ping

Get API Status

Get the current status of uberall API

Person Endpoints

GET	/api/persons	Get All Persons
POST	/api/persons	Create a Person
PATCH	/api/persons	Update a Person using identifier
DELETE	/api/persons	Delete a Person using identifier
GET	/api/persons/$id	Get a Person
PATCH	/api/persons/$id	Update a Person
DELETE	/api/persons/$id	Delete a Person

GET

/api/persons

https://uberall.com/api/persons

[ Person ,...]

Get All Persons

Get all persons the current API user can manage.
To specify products with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 URL param

POST

/api/persons

https://uberall.com/api/persons

Person

Create a Person

Create a person. It can be added to a content list later

Body Parameters

A [ Person ] object.

PATCH

/api/persons

https://uberall.com/api/persons

Person

Update a Person using identifier

Make changes to a person, always use ?identifier= in url param to identify the person uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

A [ Person ] object.

DELETE

/api/persons

https://uberall.com/api/persons

Person

Delete a Person using identifier

Delete a person identified by identifier in the url param

GET

/api/persons/$id

https://uberall.com/api/persons/$id

Person

Get a Person

Get a person identified by its uberall unique id

Path parameters

The uberall unique id of the person you want to get

PATCH

/api/persons/$id

https://uberall.com/api/persons/$id

Person

Update a Person

Make changes to a person. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id of the person you want to update

Body Parameters

A [ Person ] object.

DELETE

/api/persons/$id

https://uberall.com/api/persons/$id

Person

Delete a Person

Delete a person

Path parameters

The uberall unique id of the person you want to delete

Photo Endpoints

POST	/api/photos	Upload a Photo
GET	/api/photos/$id	Get a Photo
PATCH	/api/photos/$id	Update a Photo
DELETE	/api/photos/$id	Delete a Photo

POST

/api/photos

https://uberall.com/api/photos

LocationPhotoResponse

Upload a Photo

Upload a photo

Body Parameters

description

A description for the photo

String

identifier

The photo identifier based on your internal identification system

String

locationId

Required - The uberall unique id of this photo's location

Long

photo

Required - The photo as a file or a base64

MultipartRequest

type

Required - Required - One of:
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
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

String

GET

/api/photos/$id

https://uberall.com/api/photos/$id

LocationPhotoResponse

Get a Photo

Get a photo identified by its uberall unique id

Path parameters

The uberall unique id for the photo you want to get

PATCH

/api/photos/$id

https://uberall.com/api/photos/$id

LocationPhotoResponse

Update a Photo

Edit a photo

Path parameters

The uberall unique id for the photo you want to delete

Body Parameters

description

Required - A description for the photo

String

type

String

DELETE

/api/photos/$id

https://uberall.com/api/photos/$id

Delete a Photo

Delete a photo identified by its uberall unique id

Path parameters

The uberall unique id for the photo you want to the delete

Product Plan Endpoints

GET	/api/product-plans	Get All Product Plans
POST	/api/product-plans	Create a Product Plan
PATCH	/api/product-plans/$id	Update a Product Plan

GET

/api/product-plans

https://uberall.com/api/product-plans

[ ProductPlanResponse ,...]

Get All Product Plans

Get all product plans available to the current API user

Query Parameters

country

Optional parameter to retrieve plans and supported directories for a specific country

POST

/api/product-plans

https://uberall.com/api/product-plans

ProductPlanResponse

Create a Product Plan

Create a new Product Plan. The new Product Plan will be always created into PENDING_APPROVAL status.

Body Parameters

ProductPlan

Required - A Product Plan object

ProductPlan

PATCH

/api/product-plans/$id

https://uberall.com/api/product-plans/$id

ProductPlanResponse

Update a Product Plan

Update an existing Product Plan. Only defaultPlan, description, name, status are updatable via API.

Path parameters

The uberall unique id of the Product Plan

Body Parameters

defaultPlan

True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.

Boolean

description

Description of the plan

String

identifier

The Product Plan identifier based on your internal identification system

String

name

The name of the Product Plan

String

status

Status of the Product Plan. Is possible to change an ACTIVE Product Plan to INACTIVE and vice versa.

ProductPlanStatus

Product Endpoints

GET	/api/products	Get All Products
POST	/api/products	Create a Product
PATCH	/api/products	Update a Product using identifier
DELETE	/api/products	Delete a Product using identifier
GET	/api/products/$id	Get a Product
PATCH	/api/products/$id	Update a Product
DELETE	/api/products/$id	Delete a Product

GET

/api/products

https://uberall.com/api/products

[ Product ,...]

Get All Products

Get all products the current API user can manage.
To specify products with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 URL param

POST

/api/products

https://uberall.com/api/products

Product

Create a Product

Create a product. It can be added to a content list later

Body Parameters

A [ Product ] object.

PATCH

/api/products

https://uberall.com/api/products

Product

Update a Product using identifier

Make changes to a product, always use ?identifier= in url param to identify the product uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

Body Parameters

A [ Product ] object.

DELETE

/api/products

https://uberall.com/api/products

Product

Delete a Product using identifier

Delete a product identified by identifier in the url param

GET

/api/products/$id

https://uberall.com/api/products/$id

Product

Get a Product

Get a product identified by its uberall unique id

Path parameters

The uberall unique id for the product you want to get

PATCH

/api/products/$id

https://uberall.com/api/products/$id

Product

Update a Product

Make changes to a product. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id for the product you want to update

Body Parameters

A [ Product ] object.

DELETE

/api/products/$id

https://uberall.com/api/products/$id

Product

Delete a Product

Delete a product identified by its uberall unique id

Path parameters

The uberall unique id for the product

SalesPartners

GET	/api/sales-partners	Search among child SalesPartners
POST	/api/sales-partners	Create child SalesPartner
GET	/api/sales-partners/$id	Get a single SalesPartner
PUT	/api/sales-partners/$id	Update a single SalesPartner
PATCH	/api/sales-partners/$id/sso-settings	Update SSO Settings of a SalesPartner
DELETE	/api/sales-partners/$id/user-account/$accountId/apple_maps	Disconnect Apple Directory User Account
GET	/api/sales-partners/subscribable-event-types	Get all subscribable event types
GET	/api/sales-partners/webhooks	Get All Webhooks
POST	/api/sales-partners/webhooks	Create a Webhook
GET	/api/sales-partners/webhooks/$id	Get a Webhook
PATCH	/api/sales-partners/webhooks/$id	Update a Webhook
DELETE	/api/sales-partners/webhooks/$id	Delete a Webhook

GET

/api/sales-partners

https://uberall.com/api/sales-partners

[ SalesPartnerResponse ,...]

Search among child SalesPartners

Can be used for searching through all children SalesPartner for the given parent SalesPartner

Query Parameters

Filter by specific uberall SalesPartner id

max

Used for pagination. Maximum number of results per page. Default: 1000

offset

Offset used for pagination. Default: 0

order

Order used for pagination. Default: 'asc'

query

Filter by name or identifier

sort

SalesPartner property used for pagination. Default: 'id'

status

Filter by status

POST

/api/sales-partners

https://uberall.com/api/sales-partners

SalesPartner

Create child SalesPartner

Can be used to create new child SalesPartner that will be then associated to your parent SalesPartner.

Body Parameters

address

Required - Full address string of the new child SalesPartner (Be aware: Can't be NULL or empty)

String

aggregateInvoicesToParent

Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice

Boolean

attribution

Attribution details of the new child SalesPartner

Attribution

canSeePrices

Indicates if the child SalesPartner should be allowed to see price information for e.g. product plans

Boolean

country

Country of the new child SalesPartner

Country

emailAccounting

Accounting email of the new child SalesPartner

String

emailCustomerSupport

Customer support email of the new child SalesPartner

String

emailProjectLead

Project lead email of the new child SalesPartner

String

identifier

Identifier of the new child SalesPartner (e.g. your own customer ID for better reference)

String

minPasswordLength

Minimum password length for all users of the new child SalesPartner

Integer

name

Required - Name of child SalesPartner (Be aware: Can't be NULL or empty)

String

parent

Required - Parent ID of the associated parent SalesPartner. (Be aware: You need the Uberall SalesPartner ID of the parent)

Long

phone

Phone number of the new child SalesPartner

String

preferredLanguage

Preferred language of the new child SalesPartner, for invoice purpose (either 'de' oder 'en')

Locale

salesPartnerStatus

SalesPartner status of child SalesPartner (Be aware: Only sending 'CREATED' is allowed, but not neccessary)

SalesPartnerStatus

vatId

VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for Germany: DE123456789)

String

GET

/api/sales-partners/$id

https://uberall.com/api/sales-partners/$id

SalesPartner

Get a single SalesPartner

Can be used for retrieving informations about a single SalesPartner. This could either be your own SalesPartner or if your SalesPartner is a parent an associated child SalesPartner.

Path parameters

ID of the SalesPartner

PUT

/api/sales-partners/$id

https://uberall.com/api/sales-partners/$id

SalesPartner

Update a single SalesPartner

Can be used to either update your own SalesPartner or if your SalesPartner is a parent you will be able to also update associated child SalesPartners.

Path parameters

ID of the SalesPartner

Body Parameters

address

Full address string of the SalesPartner (Be aware: If sent it can't be NULL or empty)

String

aggregateInvoicesToParent

(only used for child SalesPartner) Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice

Boolean

attribution

Attribution details of the SalesPartner

Attribution

canSeePrices

Indicates if the SalesPartner should be allowed to see price information for e.g. product plans

Boolean

country

Country of the SalesPartner

Country

emailAccounting

Accounting email of the SalesPartner

String

emailCustomerSupport

Customer support email of the SalesPartner

String

emailProjectLead

Project lead email of the SalesPartner

String

identifier

Identifier of the SalesPartner (e.g. for child SalesPartners use your own customer ID for better reference)

String

minPasswordLength

Minimum password length for all users of the SalesPartner

Integer

name

Name of the SalesPartner (Be aware: If sent it can't be NULL or empty)

String

phone

Phone number of the SalesPartner

String

preferredLanguage

Preferred language of the SalesPartner, for invoice purpose (either 'de' oder 'en')

Locale

salesPartnerStatus

SalesPartner status of the SalesPartner (Be aware: Only sending 'INACTIVE' for child SalesPartner update is allowed)

SalesPartnerStatus

vatId

VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for Germany: DE123456789)

String

PATCH

/api/sales-partners/$id/sso-settings

https://uberall.com/api/sales-partners/$id/sso-settings

SalesPartner

Update SSO Settings of a SalesPartner

Can be used to update certain SSO settings for a single SalesPartner.

Path parameters

ID of the SalesPartner

Body Parameters

forceSso

Flag to indicate if single sign-on should be enforced. If enforced, users are allowed to log in via the single sign-on flow. Furthermore, the User's details such as name, email, feature, and others will be updateable via single sign-on only.

Boolean

DELETE

/api/sales-partners/$id/user-account/$accountId/apple_maps

https://uberall.com/api/sales-partners/$id/user-account/$accountId/apple_maps

Disconnect Apple Directory User Account

Disconnects the apple account for the passed sales partner and account id

Path parameters

accountId

Directory User Account id

Sales Partner Id

GET

/api/sales-partners/subscribable-event-types

https://uberall.com/api/sales-partners/subscribable-event-types

[ Type ,...]

Get all subscribable event types

Can be used to get a full list of all subscribable event types. These event types (if subscribed to) will generate a PushMessage that is being sent out via the implemented webhook functionality to the set pushUrl of the SalesPartner

GET

/api/sales-partners/webhooks

https://uberall.com/api/sales-partners/webhooks

[ Webhook ,...]

Get All Webhooks

Returns a list of all active webhooks

POST

/api/sales-partners/webhooks

https://uberall.com/api/sales-partners/webhooks

Webhook

Create a Webhook

Creates a new webhook, consisting of a pushUrl and a event type. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.

Body Parameters

pushUrl

Required - Url to receive webhooks

String

type

Required - Logging event type to subscribe to

Type

GET

/api/sales-partners/webhooks/$id

https://uberall.com/api/sales-partners/webhooks/$id

Webhook

Get a Webhook

Returns the webhook with the given id

Path parameters

Webhook id

PATCH

/api/sales-partners/webhooks/$id

https://uberall.com/api/sales-partners/webhooks/$id

Webhook

Update a Webhook

Edits the webhook with the given id

Path parameters

Webhook id

DELETE

/api/sales-partners/webhooks/$id

https://uberall.com/api/sales-partners/webhooks/$id

Map

Delete a Webhook

Deletes the webhook with the given id

Path parameters

Webhook id

Status Check Endpoints

GET	/api/search	Returns a list of the last searches
POST	/api/search	Initiate a Search
GET	/api/search/$id	Search in a Directory

GET

/api/search

https://uberall.com/api/search

[ SearchData ,...]

Returns a list of the last searches

Query Parameters

max

Used for pagination. Maximum number of results per page. Default: 50

offset

Offset used for pagination. Default: 0

POST

/api/search

https://uberall.com/api/search

[ SearchData ,...]

Initiate a Search

Initiate an online presence check starting with the name and address of the location

Query Parameters

city

City

country

Country. One of AT, CH, DE, ES, UK, FR, IT, NL

lat

Latitude

lng

Longitude

name

The location's name

phone

Phone number

province

Province

street

The location's street address

streetNo

unless already in address field. The location's street number

zip

Zip code

GET

/api/search/$id

https://uberall.com/api/search/$id

BasicListing

Search in a Directory

Search for a location identified by a uberall unique id in a specific directory

Path parameters

The unique id of the SearchData returned by /api/search/

Query Parameters

Service Item Endpoints

GET	/api/service-items	Get All Service Items
POST	/api/service-items	Create a Service Item
GET	/api/service-items/$id	Get a Service Item
PATCH	/api/service-items/$id	Update a Service Item
DELETE	/api/service-items/$id	Delete a Service Item

GET

/api/service-items

https://uberall.com/api/service-items

[ ServiceItem ,...]

Get All Service Items

Get all service items the current API user can manage.
To specify services with identifier please provide ?identifier= in the URL param
By default, 50 are returned, you can use up to max=10000 in the URL param

POST

/api/service-items

https://uberall.com/api/service-items

ServiceItem

Create a Service Item

Create a menu item. It can be added to a content collection later

Body Parameters

A [ ServiceItem ] object.

GET

/api/service-items/$id

https://uberall.com/api/service-items/$id

ServiceItem

Get a Service Item

Get a single service item

Path parameters

The uberall unique id for the service item

PATCH

/api/service-items/$id

https://uberall.com/api/service-items/$id

ServiceItem

Update a Service Item

Make changes to a service item.
Always use ?identifier= in url param to identify the service item uniquely.
Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The uberall unique id of the service item you want to update

Body Parameters

A [ ServiceItem ] object.

DELETE

/api/service-items/$id

https://uberall.com/api/service-items/$id

ServiceItem

Delete a Service Item

Delete a service item identified by identifier in the url param

Path parameters

The uberall unique id for the service item

GET	/api/social-posts	Get several Social Posts
POST	/api/social-posts	Create a Social Post
GET	/api/social-posts/$id	Get a Social Post
PATCH	/api/social-posts/$id	Update a Social Post
DELETE	/api/social-posts/$id	Delete a Social Post
GET	/api/social-posts/directories	Directories
GET	/api/social-posts/directory-pages	Get a list of Directory Pages
GET	/api/social-posts/templates	Get a Social Post Template
POST	/api/social-posts/templates	Create a Social Post Template
GET	/api/social-posts/templates/$id	Get all or several Social Post Templates
PATCH	/api/social-posts/templates/$id	Update a Social Post Template
DELETE	/api/social-posts/templates/$id	Delete a Social Post Template
POST	/api/social-posts/validate-apple-cta	Validate the Apple CTA

GET

/api/social-posts

https://uberall.com/api/social-posts

[ SocialPost ,...]

Get several Social Posts

Get several Social Posts.

POST

/api/social-posts

https://uberall.com/api/social-posts

SocialPost

Create a Social Post

Create a new Social Post. Requires either one businessId or one locationId or one label. When a combination of those fields is provided all matching locations are added together.

Body Parameters

A [ SocialPost ] object.

GET

/api/social-posts/$id

https://uberall.com/api/social-posts/$id

SocialPost

Get a Social Post

Get a Social Plan identified by its unique uberall ID.

Path parameters

The unique uberall ID for the Social Post you want to get.

PATCH

/api/social-posts/$id

https://uberall.com/api/social-posts/$id

SocialPost

Update a Social Post

Edit an existing Social Post identified by its unique uberall ID.

Path parameters

The unique uberall ID for the Social Post you want to edit.

Body Parameters

A [ SocialPost ] object.

DELETE

/api/social-posts/$id

https://uberall.com/api/social-posts/$id

Delete a Social Post

Delete an existing Social Post identified by its unique uberall ID.

Path parameters

The unique uberall ID for the Social Post you want to delete.

GET

/api/social-posts/directories

https://uberall.com/api/social-posts/directories

SocialPostDirectoriesResponse

Directories

Get a list of directories where a posting is possible for the given combination of parameters. The response also contains warnings like missing directory connections.

Query Parameters

appleMapsWarnings

List of warnings for Apple that should be returned. Possible values are MISSING_CONNECTION, NEEDS_REVIEW

businessIds

Return directories where posting is possible for these businessIds

excludedLocationIds

List of excluded locationIds

facebookWarnings

List of warnings for facebook that should be returned. Possible values are MISSING_CONNECTION, NEEDS_REVIEW

googleWarnings

List of warnings for google that should be returned. Possible values are MISSING_CONNECTION, MISSING_VERIFICATION, CAN_NOT_POST_ON_GOOGLE, NEEDS_REVIEW

labels

Return directories where posting is possible for these labels

locationGroupIds

Return directories where posting is possible for these locationGroupIds

locationIds

Return directories where posting is possible for these locationIds

locationWarnings

List of warnings for facebook that should be returned. Possible values are POSTING_FEATURE_MISSING, FIRST_SYNC_NOT_STARTED, NEEDS_REVIEW

otherWarnings

List of warnings for facebook that should be returned. Possible values are NEEDS_REVIEW

GET

/api/social-posts/directory-pages

https://uberall.com/api/social-posts/directory-pages

[ DirectoryPageResponse ,...]

Get a list of Directory Pages

Get several Directory Pages.

Query Parameters

levels

String that represents the level of a directory page. The 2 possible values are "LISTING" and "BUSINESS"

locationIds

Return directory pages where input locationIds have access to

page

Used for pagination. Page number we're interested in

query

Filter by page name

size

Used for pagination. It indicates the amount of result to be returned in a single page

types

The directory types we want pages for.

GET

/api/social-posts/templates

https://uberall.com/api/social-posts/templates

[ SocialPostTemplate ,...]

Get a Social Post Template

Get several Social Post Templates.

Query Parameters

max

Used for pagination. Maximum number of results per page. Default: 10

offset

Offset used for pagination. Default: 0

userId

Shows the templates of the user with this id

POST

/api/social-posts/templates

https://uberall.com/api/social-posts/templates

SocialPostTemplate

Create a Social Post Template

Create a new Social Post Template.

Body Parameters

description

Description of the Social Post Template. It is mandatory if there is no photos in the request

String

photos

Photos of the Social Post Template. It is mandatory if there is no description in the request

List

shared

Boolean value defining if this Social Post Template can be accessed by other users or not

Boolean

title

Title of the Social Post Template

String

type

Type of the Social Post Template. Could be OFFER, POST or QUESTION_AND_ANSWER

String

url

A link for the future Social Post

String

userId

Required - Id of the user that should be the owner of the template that will be created

String

GET

/api/social-posts/templates/$id

https://uberall.com/api/social-posts/templates/$id

SocialPostTemplate

Get all or several Social Post Templates

Get a Social Plan Template identified by its unique uberall ID.

Path parameters

Id of a social post template

Query Parameters

userId

Id of the user requesting the social post template

PATCH

/api/social-posts/templates/$id

https://uberall.com/api/social-posts/templates/$id

SocialPostTemplate

Update a Social Post Template

Edit an existing Social Post Template identified by its unique uberall ID.

Path parameters

The unique uberall ID for the Social Post Template you want to edit.

Body Parameters

A [ SocialPostTemplate ] object.

DELETE

/api/social-posts/templates/$id

https://uberall.com/api/social-posts/templates/$id

Delete a Social Post Template

Delete an existing Social Post Template identified by its unique uberall ID.

Path parameters

Id of a social post template

Query Parameters

userId

Id of the user requesting to delete the social post template

POST

/api/social-posts/validate-apple-cta

https://uberall.com/api/social-posts/validate-apple-cta

Validate the Apple CTA

Check if the CTA is valid for an Apple post

POST	/api/social-templates	Create a new social template as a digital asset
PATCH	/api/social-templates/$id	Edit an existing social template

POST

/api/social-templates

https://uberall.com/api/social-templates

SocialPostTemplate

Create a new social template as a digital asset

Create a new social template as a part of the Digital Asset Management (DAM) framework.

Body Parameters

asset

The DAM asset information which the template will be associated to

DamAsset

description

Description of the Social Post Template. It is mandatory if there is no photos / videos in the request

String

directories

Directories of the Social Post Template.

List

photos

Photos of the Social Post Template. It is mandatory if there are no description / videos in the request

List

shared

Boolean value defining if this Social Post Template can be accessed by other users or not

Boolean

title

Title of the Social Post Template

String

url

A link for the future Social Post

String

userId

Required - Id of the user that should be the owner of the template that will be created

String

videos

Photos of the Social Post Template. It is mandatory if there are no description / photos in the request

List

PATCH

/api/social-templates/$id

https://uberall.com/api/social-templates/$id

SocialPostTemplate

Edit an existing social template

Edit an existing social template identified by its unique uberall ID

Path parameters

The unique uberall ID for the Social Post Template you want to edit

Body Parameters

A [ SocialPostTemplate ] object.

Store Finder Endpoints

GET	/api/store-finders/$storeKey/filters	Get all possible filter values
GET	/api/store-finders/$storeKey/locations	Search among the locations
GET	/api/store-finders/$storeKey/locations/(**)	Get location details
GET	/api/store-finders/$storeKey/locations/all	Get all locations

GET

/api/store-finders/$storeKey/filters

https://uberall.com/api/store-finders/$storeKey/filters

Get all possible filter values

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 parameters

storeKey

Your store finder key

Query Parameters

country

Optional parameter to filter locations from a specific country

filters

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

language

The language to show the filter values in, e.g. 'en' or 'de'.

GET

/api/store-finders/$storeKey/locations

https://uberall.com/api/store-finders/$storeKey/locations

[ StoreFinderResponse ,...]

Search among the locations

Search among the locations of the store finder

Path parameters

storeKey

Your store finder key

Query Parameters

$filter

Only return those locations that match the given filter, e.g. "services=pickup&services=wifi&my-cool-filter=custom-value"

country

Optional parameter to filter locations from a specific country

fieldMask

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

lat

Latitude. For local search.

lng

Longitude. For local search.

max

Used for pagination. Maximum number of results per page

offset

Offset used for pagination. Default: 0

openNow

Return locations that are open now.

radius

Radius (in meters). For local search.

GET

/api/store-finders/$storeKey/locations/(**)

https://uberall.com/api/store-finders/$storeKey/locations/(**)

StoreFinderResponse

Get location details

Get details for a specific location within the store finder

Path parameters

The location identifier or its id

storeKey

Your store finder key

Query Parameters

full

When set to true you will get an enriched response

identifier

When true id is the location identifier otherwise its id

GET

/api/store-finders/$storeKey/locations/all

https://uberall.com/api/store-finders/$storeKey/locations/all

[ StoreFinderResponse ,...]

Get all locations

Get all locations in your store finder

Path parameters

storeKey

Your store finder key

Query Parameters

country

Optional parameter to filter locations from a specific country

fieldMask

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

Template Endpoints

GET	/api/templates	Get All Templates
POST	/api/templates	Creates a Template
GET	/api/templates/$id	Get a Template
PATCH	/api/templates/$id	Update a Template
DELETE	/api/templates/$id	Delete a Template
POST	/api/templates/$id/increment-usage	Increment the count of times a Template has been used
GET	/api/templates/authors	Returns a list of Authors
GET	/api/templates/tags	Returns a list of Tags

GET

/api/templates

https://uberall.com/api/templates

[ ResponseTemplate ,...]

Get All Templates

Get all templates, potentially filtered by businesses, locations, authors, ...

Query Parameters

businesses

The ids of businesses you want templates for

createdBy

The ids of authors you want templates for

direction

use asc for ascending sort or desc for descending sort

locations

The ids of locations you want templates for

maxLastEdited

The max date of the last update of the template

maxTimesUsed

The max usage count you want templates for

minLastEdited

The min date of the last update of the template

minTimesUsed

The min usage count you want templates for

page

Used for pagination. Page number we're interested in

query

Free text search that applies to title and message

size

Number of templates per page

sort

Name of the field we want to sort

Creates a Template

Creates a template

Body Parameters

businesses

Required - List of business ids that have access to the template

String

message

Required - The message that will be used in the response

String

Get a Template

Get all information about a specific template

Path parameters

The Uberall unique id of the template

PATCH

/api/templates/$id

https://uberall.com/api/templates/$id

ResponseTemplate

Update a Template

Make changes to a template. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path parameters

The Uberall unique id of the template

Body Parameters

businesses

Required - The list of businesses ids the template is created for

String

message

Required - The message that will be used in the response

String

Delete a Template

Path parameters

The Uberall unique id of the template

POST

/api/templates/$id/increment-usage

https://uberall.com/api/templates/$id/increment-usage

ResponseTemplate

Increment the count of times a Template has been used

Every time a template is used we trigger this endpoint to increment the usage count

Path parameters

The Uberall unique id of the template

GET

/api/templates/authors

https://uberall.com/api/templates/authors

[ ResponseUser ,...]

Returns a list of Authors

Returns a list containing template authors for the input business ids

Body Parameters

businesses

Required - The ids of businesses you want authors for

String

GET

/api/templates/tags

https://uberall.com/api/templates/tags

[ String ,...]

Returns a list of Tags

Returns a list containing template tags for the input business ids

Body Parameters

businesses

Required - The ids of businesses you want businesses for

String

User Endpoints

GET	/api/users	Get All Users
POST	/api/users	Create a User
GET	/api/users/$id	Get a User
PATCH	/api/users/$id	Update a User
DELETE	/api/users/$id	Delete a User
DELETE	/api/users/$id/all-sessions	Invalidate all active user sessions
POST	/api/users/login	Provide an access_token for the user
POST	/api/users/logout	Log out the current user

GET

/api/users

https://uberall.com/api/users

[ User ,...]

Get All Users

Get all users managed by the current API key

Query Parameters

identifier

Only return users with this identifier.

locationId

Id of a location the users must have administration rights to.

max

Maximum number of users to display.

offset

Offset for pagination.

order

Sort order of result list.

query

Filter by first name, last name or email, e.g. 'tom@gmail.com'

sort

Sorting criteria for result list.

POST

/api/users

https://uberall.com/api/users

User

Create a User

Create a new user, subject to throttling of 10 creations per 10 seconds.

Body Parameters

A [ User ] object.

GET

/api/users/$id

https://uberall.com/api/users/$id

User

Get a User

Get a user identified by its uberall unique id

Path parameters

The uberall unique id of the user

PATCH

/api/users/$id

https://uberall.com/api/users/$id

User

Update a User

Edit an existing user

Path parameters

The uberall unique id of the user you want to edit

Body Parameters

A [ User ] object.

DELETE

/api/users/$id

https://uberall.com/api/users/$id

Delete a User

Delete a user identified by its uberall unique id

Path parameters

The uberall unique id of the user

DELETE

/api/users/$id/all-sessions

https://uberall.com/api/users/$id/all-sessions

LogoutResponse

Invalidate all active user sessions

Invalidates all active sessions associated with the user

Path parameters

The uberall unique id of the user

POST

/api/users/login

https://uberall.com/api/users/login

LoginResponse

Provide an access_token for the user

Provides an access_token for the email or the userId provided in the LoginCommand.
The accepted couples are:
[email, password]
[email, private_key]
[userId, private_key]

Body Parameters

A [ LoginCommand ] object.

POST

/api/users/logout

https://uberall.com/api/users/logout

LogoutResponse

Log out the current user

Logs out the current user and invalidates the access_token associated with this session