Skip to content
API Reference/
/
Search in a Directory

Search in a Directory

Request

Search for a location identified by a uberall unique id in a specific directory

Security
X-PUBLIC-API-KEY
Path
idstringrequired

The unique id of the SearchData returned by /api/search/

Query
directorystring

The directory you want to search in

tokenstring

The token you got using /api/search

curl -i -X GET \
  'https://uberall.com/api/search/{id}?directory=string&token=string' \
  -H 'X-PUBLIC-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully searched directory

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

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "result": {
      "name": "string",
      "nameStatus": "MATCH",
      "street": "string",
      "streetStatus": "MATCH",
      "streetNo": "string",
      "streetNoStatus": "MATCH",
      "streetType": "ALAMEDA",
      "streetTypeStatus": "MATCH",
      "streetAndNo": "string",
      "streetAndNoStatus": "MATCH",
      "addressExtra": "building, floor, ...",
      "addressExtraStatus": "MATCH",
      "zip": "string",
      "zipStatus": "MATCH",
      "city": "string",
      "cityStatus": "MATCH",
      "addressDisplay": true,
      "addressDisplayStatus": "PRESENT",
      "phone": "string",
      "phoneStatus": "MATCH",
      "fax": "string",
      "faxStatus": "MATCH",
      "cellphone": "string",
      "cellphoneStatus": "MATCH",
      "website": "string",
      "websiteStatus": "MATCH",
      "email": "string",
      "emailStatus": "MATCH",
      "descriptionLong": "A long description (up to 1000 characters) for the location",
      "descriptionLongStatus": "MATCH",
      "descriptionShort": "string",
      "descriptionShortStatus": "MATCH",
      "imprint": "string",
      "imprintStatus": "MATCH",
      "openingHours": [
        {
          "dayOfWeek": 1,
          "closed": false,
          "from1": "08:00",
          "to1": "11:00"
        },
        {
          "dayOfWeek": 2,
          "closed": false,
          "from1": "08:00",
          "to1": "11:00",
          "from2": "13:00",
          "to2": "21:00"
        },
        {
          "dayOfWeek": 3,
          "closed": true
        }
      ],
      "openingHoursStatus": "MATCH",
      "openingHoursNotes": "We never open on bank holidays",
      "openingHoursNotesStatus": "MATCH",
      "moreHours": "<pre>[&#123;\n    \"type\": \"ONLINE_SERVICE_HOURS\",\n    \"hours\": [&#123;\n        \"dayOfWeek\": 1,\n        \"from1\": \"09:00\",\n        \"to1\": \"18:00\"\n    &#125;, &#123;\n        \"dayOfWeek\": 2,\n        \"from1\": \"09:00\",\n        \"to1\": \"13:00\"\n    &#125;]\n&#125;, &#123;\n    \"type\": \"ACCESS\",\n    \"hours\": [&#123;\n        \"dayOfWeek\": 1,\n        \"from1\": \"06:00\",\n        \"to1\": \"20:00\"\n    &#125;]\n&#125;]</pre>",
      "moreHoursStatus": "MATCH",
      "specialOpeningHours": [
        {
          "date": "2017-06-29",
          "closed": true
        },
        {
          "date": "2017-06-30",
          "from1": "11:00",
          "to1": "14:00",
          "from2": "16:00",
          "to2": "20:00"
        }
      ],
      "specialOpeningHoursStatus": "MATCH",
      "keywordsStatus": "MATCH",
      "categoriesStatus": "MATCH",
      "attributesStatus": "MATCH",
      "photosStatus": "MATCH",
      "legalIdent": "string",
      "legalIdentStatus": "MATCH",
      "taxNumber": "string",
      "taxNumberStatus": "MATCH",
      "province": "string",
      "provinceStatus": "MATCH",
      "country": "AF",
      "countryStatus": "MATCH",
      "socialPost": {
        "title": "string",
        "description": "string",
        "url": "string",
        "type": "POST",
        "alertType": "COVID_19",
        "id": 0,
        "campaignId": 0,
        "campaign": {
          "id": 0,
          "name": "string",
          "color": "string"
        },
        "status": "SCHEDULED",
        "dateStart": "2019-08-24T14:15:22Z",
        "dateEnd": "2019-08-24T14:15:22Z",
        "publicationDate": "2024-06-25T11:01:00Z",
        "isStoreLocator": true,
        "productName": "string",
        "timeZone": "Europe/Berlin",
        "productPriceMin": 0,
        "productPriceMax": 0,
        "productCurrency": "EUR",
        "labels": "['Campaign2018', 'EastCoast']",
        "photos": [
          {
            "redirectUrl": "string",
            "photo": "string",
            "description": "string"
          }
        ],
        "callToActions": [
          {
            "url": "string",
            "type": "string",
            "directory": "string"
          }
        ],
        "firstComment": "string",
        "mentions": [
          {
            "id": "string",
            "name": "string",
            "link": "string",
            "avatar": "string"
          }
        ],
        "statusPerDirectory": {},
        "publicationsCount": 0,
        "videos": [
          "string"
        ],
        "businessIds": [
          0
        ],
        "locationIds": [
          0
        ],
        "listingPages": [
          0
        ],
        "businessPages": [
          0
        ],
        "locationGroups": [
          0
        ],
        "excludedLocationIds": [
          0
        ],
        "directories": [
          {
            "type": "FOURSQUARE",
            "url": "string"
          }
        ],
        "couponCode": "string",
        "termsAndConditions": "string",
        "canEdit": true,
        "locationName": "string",
        "businessName": "string",
        "warnings": [
          "string"
        ],
        "insights": [
          {
            "metrics": {
              "property1": 0,
              "property2": 0
            }
          }
        ],
        "owner": {
          "id": 0,
          "name": "string",
          "isApiAdmin": true
        }
      },
      "socialPostStatus": "MATCH",
      "videosStatus": "MATCH",
      "contentListsStatus": "MATCH",
      "socialProfilesStatus": "MATCH",
      "paymentOptionsStatus": "MATCH",
      "brandsStatus": "MATCH",
      "servicesStatus": "MATCH",
      "transactionLinksStatus": "MATCH",
      "languagesStatus": "MATCH",
      "attribution": {
        "name": "string",
        "url": "string",
        "id": 0,
        "logo": {
          "url": "string",
          "type": "LOGO",
          "description": "string"
        }
      },
      "attributionStatus": "MATCH",
      "lat": 0.1,
      "latStatus": "MATCH",
      "lng": 0.1,
      "lngStatus": "MATCH",
      "serviceAreasStatus": "MATCH",
      "rating": 0.1,
      "ratingStatus": "MATCH",
      "numberOfRatings": 0,
      "numberOfRatingsStatus": "MATCH",
      "listingId": "string",
      "listingUrl": "string",
      "directoryType": "FOURSQUARE",
      "flowStatus": "SUBMISSION_NEEDED",
      "syncStatus": "IN_SYNC",
      "claimStatus": "CLAIMABLE",
      "npi": "1558444216",
      "npiStatus": "MISSING",
      "doctorCategoriesStatus": "MATCH",
      "nameDescriptor": "string",
      "nameDescriptorStatus": "MATCH",
      "dateCreated": "2019-08-24T14:15:22Z",
      "openingDate": "2019-08-24",
      "openingDateStatus": "MATCH",
      "customFields": {
        "property1": "string",
        "property2": "string"
      },
      "customFieldsStatus": "MATCH",
      "sublocality": "string",
      "sublocalityStatus": "MATCH",
      "websiteExtra": "string",
      "photos": true,
      "keywords": [
        "string"
      ],
      "categories": [
        0
      ]
    }
  }
}