/customers/get


Get customers details by custom terms like customId, email. Results are limited to 500 per page.


Parameters

Name Type Required Example Description
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.
businessId integer no 6418 Business ID (or multiple comma-separated ids.)
customerId integer no 12 Customer ID
customId string(255) no 74d34e3b Custom ID
jobId string(100) no ford Job ID
email string(email) no john.smith@app.gatherup.com Customer email address.
page integer no 1 Page.
subscription integer no 1 Subscription of customer.
aggregateResponse integer no 1 It will return an array with results of numbered items.

Request

{
    "businessId": "40376,4398",
    "customId1": "74d34e3b",
    "clientId": "04f78076fbfc66940169d2199af7c6698019f9f3",
    "hash": "67fbca027648a3caf08e47ca685d772aa2d92fb526b8b6e91d74286301c99988"
}

Response

{
    "page": 1,
    "pages": 1,
    "id1": 1,
    "businessId1": "376",
    "firstName1": "John",
    "lastName1": "Smith",
    "email1": "john.smith@abc-company.com",
    "phone1": "",
    "jobId1": "",
    "customId1": "74d34e3b",
    "rating1": "5.00",
    "review1": "Very professional and knowledgable service",
    "statusInfo1": "Feedback received",
    "subscription1": 1
    "count": 1,
    "perPage": 500,
    "errorCode": 0,
    "errorMessage": "Success"
}

Errors

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