/businesses/get


Get list of all your business locations. Each response will be numered with id, starting with 1, for example businessId1, businessId2, ... , businessId{count}. Parameter count will be returned in the response.


Parameters

Name Type Required Example Description
clientId string(40) yes 04f78...9f9f3 Client id is a unique user identifier provided by GatherUp.
includeDeletedBusinesses integer(0,1) no 1 Set to 0 if you want to hide deleted businesses, default value is 1.
hash string(64) yes bd13a40...303f3c5 Hash is a digital request signature. Learn how to generate hash here.
page integer no 1 Page number, if not specified then page = 1
aggregateResponse integer no 1 It will return an array with results of numbered items.

Request

{
    "clientId": "627d5e234e1a2f503c9e12262cf313d693575895",
    "hash": "25c1ecd01f97fa19d42395f050414c71fd706510b44814d01d600a0f90101246",
    "page": 1
}

Response

{
    "page": 1,
    "perPage": 100,
    "pages": 1,
    "businessId1": 376,
    "businessDeleted1": 0,
    "businessName1": "Peach Trees Intl.",
    "businessPhone1": "808-333-3334",
    "businessCity1": "Haiku",
    "businessState1": "HI",
    "businessZip1": "96708",
    "businessCountry1": "US",
    "businessStreetAddress1": "150 Hana Hwy",
    "businessType1": "LocalBusiness",
    "businessOrganisationType1": "company",
    "customField1": "12345", // displayed only if not empty
    "businessWebsiteURL1": "https:\/\/www.peachtreeintl.abc-company.com", // displayed only if not empty
    "businessPackage1": "pro-plus",
    "count": 1,
    "errorCode": 0,
    "errorMessage": "Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support