Skip to content
API Reference/
/
Get the recommended attri...

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

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

Get the recommended attributes for a Category

Request

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
Security
X-API-KEY or Authorization
Path
idstringrequired

The Category id

Query
keywordsArray of strings

Keywords to look for which are associated with attributes

locationIdstring

Location id to exclude already applied attributes on the provided location

countrystringrequired

The country to retrieve the attribute recommendations for

curl -i -X GET \
  'https://uberall.com/api/categories/{id}/attribute-recommendations?keywords=string&locationId=string&country=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved recommended attributes

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.​recommendedAttributeExternalIdsArray of strings
Response
No content

Get Attributes for a specific Category

Request

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

Security
X-API-KEY or Authorization
Path
idstringrequired

The Category id

Query
languagestring

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

countrystringrequired

The country to retrieve the attributes for

curl -i -X GET \
  'https://uberall.com/api/categories/{id}/attributes?language=string&country=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved attributes

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.​attributesArray of objects
Response
No content

Get All or Several Categories

Request

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

Security
X-API-KEY or Authorization
Query
categoriesinteger(int64)

The uberall unique id of the category you want to get

qstring

Filter categories by a search query

Example: q=Auto
rootsboolean

Set to 'true' to show root categories as well (i.e., show all categories)

languagestringrequired

Show categories in the specified language. One of de, en, es, fr

maxinteger(int64)

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

Example: max=10
offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/categories?categories=0&q=Auto&roots=true&language=string&max=10&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved categories

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.​maxinteger(int32)

The max number of results

Example: 1
response.​offsetinteger(int32)

The offset

response.​countinteger(int32)

The total count of results

Example: 1
response.​resultsobject

Results

response.​suggestionResultsobject
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "max": 1,
    "offset": 0,
    "count": 1,
    "results": { … },
    "suggestionResults": { … }
  }
}

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