/business/online-review-links/get
Get your business online review links.
Each response will be numered with id, starting with 1, for example OnlineReviewLinkType1, OnlineReviewLinkType2, ... , OnlineReviewLinkType{count}.
Parameter count will be returned in the response.
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
POST https://app.gatherup.com/api/business/online-review-links/get
[Content-Type: application/json]
{
"businessId": 6418,
"clientId": "627d5e234e1a2f503c9e12262cf313d693575895",
"hash": "b98340caf25c00be59f5bb5405ca8f358edf22c15a4f8527785af047e541f857"
}
Response
{
"OnlineReviewLinkType1": "google",
"OnlineReviewLinkUrl1": "https:\/\/plus.google.com\/demo-url\/about",
"OnlineReviewLinkShow1": 1, # Ask for reviews on this profile URL
"OnlineReviewLinkType2": "facebook",
"OnlineReviewLinkUrl2": "https:\/\/www.facebook.com\/pages\/demo-url",
"OnlineReviewLinkShow2": 0,
"OnlineReviewLinkType3": "yelp",
"OnlineReviewLinkUrl3": "http:\/\/www.yelp.com\/biz\/demo-url",
"OnlineReviewLinkShow3": 1,
"count": 4,
"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 |