API Reference
/
Listings
/
Get all Listings for a specific Location

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

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

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Social Posting Templates

Products - Social Posting - Social Posting Templates

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

Flag a Listing

Request

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

Path
idstringrequired

The uberall unique ID for the listing to flag

curl -i -X PUT \
  'https://docs.uberall.com/_mock/apis/swagger/listings/{id}/flag' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully flagged Listing

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
No content

Get all Listings for a specific Location

Request

Lists all the details of all Listings for a specific Location

Path
idstringrequired

The uberall unique id of the location

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}/listings-details/list' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Listings details successfully retrieved

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

Listings details response model

response.​statisticobject

Statistics model

response.​listingsResponseArray of objects(ListingDetails)

Detailed response for the listings

response.​firstSyncStartedstring(date-time)

Date & time the first sync was started on the location.

Response
No content

DEPRECATED - Connect Facebook PageDeprecated

Request

Connect a Facebook page to the location

Path
idstringrequired

The uberall unique id of the location

Query
fb_access_tokenstring

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

pageIdstring

The Facebook unique id of the page you want to connect

curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}/facebook/page?fb_access_token=string&pageId=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Facebook page connected

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.​pageobject

Abstract class representing a directory page

Response
No content

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Menu Items

Locations Hub - Locations - Menu Items

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