Get a list of basic business details

Request

Get a list of basic business details containing "id" and "name", that can be viewed by the current user.

Security

X-API-KEY or Authorization

Query

querystring

Value used to filter the results. The value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".

sortstring

The business property to sort by. Can be "id" or "name".

maxstring

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

offsetstring

Offset used for pagination. Default: 0

orderstring

Sets the sorting order. Default: "asc".

curl -i -X GET \
  'https://uberall.com/api/locations/businesses?query=string&sort=string&max=string&offset=string&order=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Businesses

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

Business Page Response Model

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "businesses": [
      {
        "addressLine2": "string",
        "businessSyncable": true,
        "city": "string",
        "country": "AF",
        "dateCreated": "2019-08-24T14:15:22Z",
        "dateExpiration": "2019-08-24T14:15:22Z",
        "defaultOriginalPrice": 0,
        "defaultPrice": 0,
        "defaultPriceSetup": 0,
        "id": 0,
        "identifier": "string",
        "name": "string",
        "type": "SMB",
        "phone": "string",
        "province": "string",
        "status": "CREATED",
        "streetAndNo": "string",
        "zip": "string",
        "nextProductPlanId": 0,
        "effectiveDate": "2019-08-24T14:15:22Z",
        "numOfLocations": 0,
        "productPlan": {
          "id": 0,
          "name": "string",
          "salesPartnerId": 0,
          "features": [
            "ADS"
          ],
          "updatedDirectories": [
            "FOURSQUARE"
          ],
          "countryPrice": [
            {
              "country": "AF",
              "price": 0,
              "marketDevelopmentFunds": 0,
              "priceSetup": 0
            }
          ],
          "currency": "string",
          "defaultPlan": true,
          "identifier": "string",
          "description": "string",
          "dateCreated": "2019-08-24T14:15:22Z",
          "lastUpdated": "2019-08-24T14:15:22Z",
          "duration": 0,
          "initialDuration": 0,
          "billingPeriod": 0,
          "initialBillingPeriod": 0,
          "defaultPrice": 0,
          "defaultOriginalPrice": 0,
          "defaultPriceSetup": 0,
          "defaultMarketDevelopmentFunds": 0,
          "status": "ACTIVE"
        },
        "countryPrices": [
          {
            "country": "AF",
            "price": 0,
            "priceSetup": 0,
            "marketDevelopmentFunds": 0,
            "currency": "string"
          }
        ],
        "productPlanId": 0,
        "defaultCurrency": "string",
        "fieldMask": [
          "string"
        ],
        "productPlanFieldMask": [
          "string"
        ],
        "customFields": [
          "string"
        ],
        "directoryBusinessPages": [
          {
            "id": 0,
            "type": "FACEBOOK",
            "directoryBusinessPageId": "string",
            "status": "VALID"
          }
        ]
      }
    ],
    "max": 0,
    "offset": 0,
    "count": 0,
    "warnings": [
      "string"
    ]
  }
}