Skip to content
API Reference/
/
Get all Listings for a sp...

Get all Listings for a specific Location

Request

Lists all the details of all Listings for a specific Location

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the location

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

Responses

Listings details successfully retrieved

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Listings details response model

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "statistic": {
      "totalListings": 0,
      "countListingsInSync": 0,
      "countListingsSubmitted": 0,
      "countListingsBeingUpdated": 0,
      "countListingsLinked": 0,
      "countListingsActionRequired": 0,
      "countListingsScheduled": 0
    },
    "listingsResponse": [
      {
        "type": "string",
        "typeName": "string",
        "category": "social, search",
        "id": 0,
        "listingUrl": "string",
        "mandatoryFieldsMissing": [
          "string"
        ],
        "directorySpecificData": {
          "requestAdminRightsUrl": "string",
          "status": "string"
        },
        "directoryContactDetails": {
          "email": "string",
          "website": "string"
        },
        "directoryConnectInfo": {
          "status": "CONNECTED",
          "userDetails": {
            "id": 0,
            "name": "string",
            "email": "string",
            "dateConnected": "2019-08-24T14:15:22Z",
            "defaultForSalesPartner": true,
            "defaultForBusiness": true
          }
        },
        "status": "SYNCED",
        "action": "CONNECT",
        "lastUpdateAttempt": "2019-08-24T14:15:22Z",
        "expectedSyncDuration": 0
      }
    ],
    "firstSyncStarted": "2019-08-24T14:15:22Z",
    "lastSyncStarted": "2019-08-24T14:15:22Z",
    "autoSyncEnabled": true,
    "openingSoon": true,
    "openingDate": "2019-08-24"
  }
}