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

NameTypeRequiredDescription
reviewCampaignIdstringrequiredReview 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'

Responses

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

NameTypeRequiredDescription
dataobjectoptional
data.reviewCampaignInfoobjectoptional
data.reviewCampaignInfo.campaignNamestringoptionalName of the review campaign
data.reviewCampaignInfo.reviewCampaignCustomersarray of objectoptional
data.reviewCampaignInfo.reviewCampaignCustomers[].namestringoptionalCustomer's name
data.reviewCampaignInfo.reviewCampaignCustomers[].phonestringoptionalCustomer's phone number
data.reviewCampaignInfo.reviewCampaignCustomers[].emailstringoptionalCustomer's email address
data.reviewCampaignInfo.reviewCampaignCustomers[].ratingintegeroptionalCustomer's rating
data.reviewCampaignInfo.reviewCampaignCustomers[].responsestringoptionalCustomer's feedback response
data.reviewCampaignInfo.reviewCampaignCustomers[].datestringoptionalDate of the response
data.reviewCampaignInfo.reviewCampaignCustomers[].followUpSentintegeroptionalNumber of follow-ups sent
data.reviewCampaignInfo.reviewCampaignCustomers[].smsDeliveredAtstringoptionalTimestamp when SMS was delivered
data.reviewCampaignInfo.reviewCampaignCustomers[].smsOpenedAtstringoptionalTimestamp when SMS was opened
data.reviewCampaignInfo.reviewCampaignCustomers[].emailDeliveredAtstringoptionalTimestamp when email was delivered
data.reviewCampaignInfo.reviewCampaignCustomers[].emailLastOpenedAtstringoptionalTimestamp when email was last opened
data.reviewCampaignInfo.reviewCampaignCustomers[].emailLastClickedAtstringoptionalTimestamp when email was last clicked
data.reviewCampaignInfo.reviewCampaignCustomers[].firstFollowUpAtstringoptionalTimestamp when first follow-up was sent
data.reviewCampaignInfo.reviewCampaignCustomers[].firstFollowUpDeliveredAtstringoptionalTimestamp when first follow-up was delivered
data.reviewCampaignInfo.reviewCampaignCustomers[].secondFollowUpAtstringoptionalTimestamp when second follow-up was sent
data.reviewCampaignInfo.reviewCampaignCustomers[].secondFollowUpDeliveredAtstringoptionalTimestamp when second follow-up was delivered