/business/get


Get your business location details.


Parameters

Name Type Required Example Description
businessId integer yes 6418 Business id.
clientId string(40) yes 04f78...9f9f3 Client id is a unique user identifier provided by GatherUp.
hash string(64) yes bd13a40...303f3c5 Hash is a digital request signature. Learn how to generate hash here.

Request

{
    "businessId": 6418,
    "clientId": "627d5e234e1a2f503c9e12262cf313d693575895",
    "hash": "b98340caf25c00be59f5bb5405ca8f358edf22c15a4f8527785af047e541f857"
}

Response

{
    "id": 6418,
    "name": "Peach Trees Intl.",
    "phone": "808-333-3334",
    "city": "Haiku",
    "state": "HI",
    "zip": "96708",
    "country": "US",
    "streetAddress": "150 Hana Hwy",
    "timezone": "Honolulu Hawaii",
    "type": "LocalBusiness",
    "organisationType": "company",
    "emailLogo": "https://example.com/template/logo-53202",
    "emailImage": null,
    "feedbackBanner": "https://example.com/feedback/banner-owner-53202",
    "extraField" : "Extra field content", // displayed only if not empty
    "customField": "12345", // displayed only if not empty
    "websiteURL": "https:\/\/www.peachtreeintl.abc-company.com", // displayed only if not empty
    "package": "pro-plus",
    "shortFeedbackUrl": "https:\/\/app.gatherup.com\/f.2", // url to the leave feedback form
    "communicationMethod": "Automatic",\\ or Manual
    "communicationSendEmail”: “5”, \\ Amount of emails that are set to go daily in automatic mode
    "nps": "9", \\ Lifetime
    "feedbacksReceived": "560", \\ Lifetime
    "customersNotSent": "12", \\ Customers that have not received a feedback request
    "errorCode": 0,
    "errorMessage": "Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support
5 This user cannot manage selected business
25 Business does not exist