Skip to content
API Reference
/
Businesses
/
Get a List of Businesses

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers

https://uberall.com/api/

Mock Server

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

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Get a List of Businesses

Request

Get a list of businesses managed by the current user.

Security
X-API-KEY or Authorization
Query
querystring

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".

queryFieldsArray of strings

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

identifierstring

Only return one business based on your internal identification system

businessIdsstring

Only return businesses identified by ids listed in businessIds

statusstring

Filter by business status. One of ACTIVE, INACTIVE

minLocationsstring

Only return businesses with at least minLocations locations

maxLocationsstring

Only returns businesses with at most maxLocations locations

productPlanstring

Query accounts by product plan name.

productPlanIdstring

Query accounts by product plan Id.

sortstring

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

maxstring

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

offsetstring

Offset used for pagination. Default: 0

fieldMaskstring

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

Example: fieldMask=fieldMask=type&fieldMask=city
curl -i -X GET \
  'https://uberall.com/api/businesses?query=string&queryFields=string&identifier=string&businessIds=string&status=string&minLocations=string&maxLocations=string&productPlan=string&productPlanId=string&sort=string&max=string&offset=string&fieldMask=fieldMask%3Dtype%26fieldMask%3Dcity' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Businesses

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Business Page Response Model

response.​businessesArray of objects(BusinessResponse)

List of businesses

response.​maxinteger(int32)

Max

response.​offsetinteger(int32)

Offset

response.​countinteger(int64)

Total number of businesses

response.​warningsArray of strings

List of warnings

Response
No content

Create a Business

Request

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

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A Business object

namestringrequired

Name of the business

Example: "Minimalistic business"
streetAndNostring

Address of the business

Example: "Piac utca 22."
addressLine2string

An address extra

zipstring

Zip code of the business

Example: "4025"
citystring

City of the business

Example: "Debrecen"
countrystring

Country of the business

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
Example: "HU"
contractDurationinteger(int64)

Contract Duration

Example: 12
productPlaninteger(int64)

Product plan

Example: 2404
curl -i -X POST \
  https://uberall.com/api/businesses \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Minimalistic business",
    "streetAndNo": "Piac utca 22.",
    "addressLine2": "string",
    "zip": "4025",
    "city": "Debrecen",
    "country": "HU",
    "contractDuration": 12,
    "productPlan": 2404
  }'

Responses

Business successfully created

Bodyapplication/json
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​businessobject

Business Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "business": { … }
  }
}

Get a Business

Request

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

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the business

curl -i -X GET \
  'https://uberall.com/api/businesses/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Business

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​businessobject

Business Model

Response
No content

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations