Skip to content
/Locations Photos

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

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

Upload a Photo

Request

Upload a photo

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

The photo data to upload

descriptionstring

A description for the photo - max 255 chars

sourceUrlstring

The URL to the original photo

identifierstring

The photo identifier based on your internal identification system

cropOffsetXinteger(int32)

Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]

cropOffsetYinteger(int32)

Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]

cropWidthinteger(int32)

Width of the 16:9 cropped area [LANDSCAPE photo only]

cropHeightinteger(int32)

Height of the 16:9 cropped area [LANDSCAPE photo only]

typestringrequired

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

Enum"MAIN""DOCTOR_COM_PORTRAIT""LOGO""STOREFINDER_LOGO""SQUARED_LOGO""LANDSCAPE""STOREFINDER_COVER""FACEBOOK_LANDSCAPE""APPLE_LANDSCAPE""MENU"
orderinteger(int32)

Sets the order in which the photos should be shown

dateCreatedstring(date-time)

The date when the object was created in uberall database

lastUpdatedstring(date-time)

Date of the last changes made to the photo

photostringrequired
locationIdinteger(int64)required
curl -i -X POST \
  https://uberall.com/api/photos \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "description": "string",
    "sourceUrl": "string",
    "identifier": "string",
    "cropOffsetX": 0,
    "cropOffsetY": 0,
    "cropWidth": 0,
    "cropHeight": 0,
    "type": "MAIN",
    "order": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "photo": "string",
    "locationId": 0
  }'

Responses

The photo has been uploaded

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

Location photo response model

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

Get a Photo

Request

Get a photo identified by its uberall unique id

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the photo

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

Responses

Successfully retrieved the photo

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

Location photo response model

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

Delete a Photo

Request

Delete a photo identified by its uberall unique id

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the photo

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

Responses

The photo has been deleted

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
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations