GETapi.synup.com/api/v4/locations/review-campaigns/{reviewCampaignId}/customers
List review campaign customers
Retrieves a list of customers associated with a specific review campaign, along with their response status.
Behavior:
- Returns customer details, including name, email/phone, and response status.
- Indicates whether a review was submitted, ignored, or pending.
- Supports filtering by response type (e.g., responded, not responded).
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
reviewCampaignId | string | required | Review campaign ID to list customers for |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/locations/review-campaigns/:reviewCampaignId/customers' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/locations/review-campaigns/:reviewCampaignId/customers', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/locations/review-campaigns/:reviewCampaignId/customers",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/review-campaigns/:reviewCampaignId/customers", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
Example response
{
"data": {
"reviewCampaignInfo": {
"campaignName": "Joe",
"reviewCampaignCustomers": [
{
"name": "Jack",
"phone": "9876543210",
"email": "jack@domain.com",
"rating": 5,
"response": "Great Service provided",
"date": "2018-04-12",
"followUpSent": 2,
"smsDeliveredAt": "2018-04-04 01:00:12",
"smsOpenedAt": "2018-04-04 01:00:57",
"emailDeliveredAt": "2018-04-04 01:00:12",
"emailLastOpenedAt": "2018-04-04 01:00:57",
"emailLastClickedAt": "2018-04-04 01:00:57",
"firstFollowUpAt": "2018-04-07 18:34:06",
"firstFollowUpDeliveredAt": "2018-04-08 20:34:06",
"secondFollowUpAt": "2018-04-10 18:34:06",
"secondFollowUpDeliveredAt": "2018-04-11 18:34:06"
}
]
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.reviewCampaignInfo | object | optional | |
data.reviewCampaignInfo.campaignName | string | optional | Name of the review campaign |
data.reviewCampaignInfo.reviewCampaignCustomers | array of object | optional | |
data.reviewCampaignInfo.reviewCampaignCustomers[].name | string | optional | Customer's name |
data.reviewCampaignInfo.reviewCampaignCustomers[].phone | string | optional | Customer's phone number |
data.reviewCampaignInfo.reviewCampaignCustomers[].email | string | optional | Customer's email address |
data.reviewCampaignInfo.reviewCampaignCustomers[].rating | integer | optional | Customer's rating |
data.reviewCampaignInfo.reviewCampaignCustomers[].response | string | optional | Customer's feedback response |
data.reviewCampaignInfo.reviewCampaignCustomers[].date | string | optional | Date of the response |
data.reviewCampaignInfo.reviewCampaignCustomers[].followUpSent | integer | optional | Number of follow-ups sent |
data.reviewCampaignInfo.reviewCampaignCustomers[].smsDeliveredAt | string | optional | Timestamp when SMS was delivered |
data.reviewCampaignInfo.reviewCampaignCustomers[].smsOpenedAt | string | optional | Timestamp when SMS was opened |
data.reviewCampaignInfo.reviewCampaignCustomers[].emailDeliveredAt | string | optional | Timestamp when email was delivered |
data.reviewCampaignInfo.reviewCampaignCustomers[].emailLastOpenedAt | string | optional | Timestamp when email was last opened |
data.reviewCampaignInfo.reviewCampaignCustomers[].emailLastClickedAt | string | optional | Timestamp when email was last clicked |
data.reviewCampaignInfo.reviewCampaignCustomers[].firstFollowUpAt | string | optional | Timestamp when first follow-up was sent |
data.reviewCampaignInfo.reviewCampaignCustomers[].firstFollowUpDeliveredAt | string | optional | Timestamp when first follow-up was delivered |
data.reviewCampaignInfo.reviewCampaignCustomers[].secondFollowUpAt | string | optional | Timestamp when second follow-up was sent |
data.reviewCampaignInfo.reviewCampaignCustomers[].secondFollowUpDeliveredAt | string | optional | Timestamp when second follow-up was delivered |