/business/search


Finding the Business ID for one or multiple Businesses by Custom Field or Extra Field.
If you are not using those fields you can manually get the Business ID as shown here: http://userguide.gatherup.com/how-to-get-the-business-id-for-api-calls/


Parameters

Name Type Required Example Description
by string yes customField Search by...
Possible values: customField, extraField
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.
search string yes search string Search value

Request

{  
   "by":"customField",
   "clientId":"262928ea7f50adf1ffcdba64f18fe35ab9d73d7a",
   "hash":"d57a159bf730a92a8561bdb7be0e42aeefd861f387e9576952bd48493a8e404d",
   "search":"demo"
}

Response

{
    "businessId": 6418,
    "errorCode": 0,
    "errorMessage": "Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support
25 Business does not exist
26 Invalid search type