Skip to content
API Reference/
/
Get available and potenti...

Uberall API (20260101)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
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

Configuration

Set up - Configuration

Operations

Get All Directories details by country

Request

Returns a list of directories details filtered by country

Security
Authorization
Query
countriesstring

Optional list parameter of comma separated ISO 3166 alpha-2 country codes to filter response

Example: countries=US, DE
curl -i -X GET \
  'https://uberall.com/api/directories/directories-details/countries?countries=US%2C+DE' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved Directories Details

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.​itemsArray of objects
response.​countinteger(int32)

Total count of countries

Example: 195
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​nextOffsetinteger(int32)

Next offset for pagination

Example: 10
Response
No content

Get available and potential features per location (business)

Request

Get user features partitioned by location.

Security
X-API-KEY or Authorization
curl -i -X GET \
  https://uberall.com/api/features \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Features successfully retrieved

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

Features Response Model

response.​locationsArray of objects

Get user features partitioned by location.

response.​defaultFeaturesArray of strings

A list with the default features for the user.

Items Enum"ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING""APPLE_POSTING_WRITE"
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "locations": [ … ],
    "defaultFeatures": [ … ]
  }
}

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 Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social AI Service

Products - Social AI Service

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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