Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
locationIdstringrequiredLocation ID to list review campaigns for

Query

NameTypeRequiredDescription
startDatestringoptionalStart date of a date range to get review campaigns
endDatestringoptionalEnd 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'

Responses

StatusDescription
200Successful 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

NameTypeRequiredDescription
dataobjectoptional
data.listReviewCampaignsobjectoptional
data.listReviewCampaigns.reviewCampaignsarray of objectoptional
data.listReviewCampaigns.reviewCampaigns[].idstringoptionalUnique identifier for the review campaign
data.listReviewCampaigns.reviewCampaigns[].locationIdstringoptionalLocation identifier
data.listReviewCampaigns.reviewCampaigns[].namestringoptionalName of the campaign
data.listReviewCampaigns.reviewCampaigns[].screeningbooleanoptionalWhether screening is enabled
data.listReviewCampaigns.reviewCampaigns[].createdAtstringoptionalCreation timestamp
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplateobjectoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.contentstringoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.fromEmailstringoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.headingstringoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.replyTostringoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.reviewSiteHasharray of stringoptional
data.listReviewCampaigns.reviewCampaigns[].openingEmailTemplate.subjectstringoptional
data.listReviewCampaigns.reviewCampaigns[].smsTemplateobjectoptional
data.listReviewCampaigns.reviewCampaigns[].smsTemplate.contentstringoptional
data.listReviewCampaigns.reviewCampaigns[].smsTemplate.reviewSiteHasharray of stringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpSchedulestringoptional
DAYS_2DAYS_5
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplateobjectoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.contentstringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.fromEmailstringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.headingstringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.replyTostringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.reviewSiteHasharray of stringoptional
data.listReviewCampaigns.reviewCampaigns[].firstFollowUpTemplate.subjectstringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpSchedulestringoptional
DAYS_2DAYS_5
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplateobjectoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.contentstringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.fromEmailstringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.headingstringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.replyTostringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.reviewSiteHasharray of stringoptional
data.listReviewCampaigns.reviewCampaigns[].secondFollowUpTemplate.subjectstringoptional
data.listReviewCampaigns.reviewCampaigns[].statsarray of objectoptional
data.listReviewCampaigns.reviewCampaigns[].stats[].namestringoptional
emails_sentsms_sentinvite_open_rateclicks_ratecustomer_exp_score
data.listReviewCampaigns.reviewCampaigns[].stats[].valuestringoptional
data.listReviewCampaigns.reviewCampaigns[].numberOfFeedbacksintegeroptionalTotal number of feedbacks received