GETapi.synup.com/api/v4/locations/{locationId}/review-campaigns
List review campaigns
This API retrieves a list of review campaigns associated with a specific location.
Behavior:
- Returns campaign details, including campaign ID, name, status, start date, and delivery method.
- Supports pagination for large datasets.
- Allows filtering by campaign status (active, completed, scheduled).
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Path
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | Location ID to list review campaigns for |
Query
| Name | Type | Required | Description |
|---|---|---|---|
startDate | string | optional | Start date of a date range to get review campaigns |
endDate | string | optional | End date of a date range to get review campaigns |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/locations/:locationId/review-campaigns?startDate=&endDate=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/locations/:locationId/review-campaigns?startDate=&endDate=', {
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/:locationId/review-campaigns?startDate=&endDate=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/:locationId/review-campaigns?startDate=&endDate=", 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": {
"listReviewCampaigns": {
"reviewCampaigns": [
{
"id": "126dc120-acea-4bcb-8a83-74c80f6f807d",
"locationId": "TG9jYXRpb246MTQwMjQ=",
"name": "Christmas Sale Feedback",
"screening": false,
"createdAt": "2019-01-21T04:29:49Z"
}
]
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.listReviewCampaigns | object | optional | |
data.listReviewCampaigns.reviewCampaigns | array of object | optional | |
data.listReviewCampaigns.reviewCampaigns[].id | string | optional | Unique identifier for the review campaign |
data.listReviewCampaigns.reviewCampaigns[].locationId | string | optional | Location identifier |
data.listReviewCampaigns.reviewCampaigns[].name | string | optional | Name of the campaign |
data.listReviewCampaigns.reviewCampaigns[].screening | boolean | optional | Whether screening is enabled |
data.listReviewCampaigns.reviewCampaigns[].createdAt | string | optional | Creation timestamp |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate | object | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.content | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.fromEmail | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.heading | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.replyTo | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.reviewSiteHash | array of string | optional | |
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.subject | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].smsTemplate | object | optional | |
data.listReviewCampaigns.reviewCampaigns[].smsTemplate.content | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].smsTemplate.reviewSiteHash | array of string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpSchedule | string | optional | DAYS_2DAYS_5 |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate | object | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.content | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.fromEmail | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.heading | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.replyTo | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.reviewSiteHash | array of string | optional | |
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.subject | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpSchedule | string | optional | DAYS_2DAYS_5 |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate | object | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.content | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.fromEmail | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.heading | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.replyTo | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.reviewSiteHash | array of string | optional | |
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.subject | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].stats | array of object | optional | |
data.listReviewCampaigns.reviewCampaigns[].stats[].name | string | optional | emails_sentsms_sentinvite_open_rateclicks_ratecustomer_exp_score |
data.listReviewCampaigns.reviewCampaigns[].stats[].value | string | optional | |
data.listReviewCampaigns.reviewCampaigns[].numberOfFeedbacks | integer | optional | Total number of feedbacks received |