---
title: "List review campaigns"
method: GET
path: "/locations/{locationId}/review-campaigns"
tags: ["Review Campaigns"]
---

# List review campaigns

`GET /locations/{locationId}/review-campaigns`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/{locationId}/review-campaigns`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/:locationId/review-campaigns/get.ts> (a function with typed inputs; its response is checked against the schema)

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).

## Path parameters

- `locationId` string, required

## Query parameters

- `startDate` string, date
- `endDate` string, date

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- ReviewCampaignsResponse
  - `data` object
    - `listReviewCampaigns` object
      - `reviewCampaigns` ReviewCampaignV2[]
        - `id` string, uuid: Unique identifier for the review campaign
        - `locationId` string: Location identifier
        - `name` string: Name of the campaign
        - `screening` boolean: Whether screening is enabled
        - `createdAt` string, date-time: Creation timestamp
        - `openingEmailTemplate` EmailTemplateV4
          - `content` string
          - `fromEmail` string, email
          - `heading` string
          - `replyTo` string, email
          - `reviewSiteHash` string[]
          - `subject` string
        - `smsTemplate` SmsTemplateV2
          - `content` string
          - `reviewSiteHash` string[]
        - `firstFollowUpSchedule` 'DAYS_2' | 'DAYS_5'
        - `firstFollowUpTemplate` EmailTemplateV4
          - `content` string
          - `fromEmail` string, email
          - `heading` string
          - `replyTo` string, email
          - `reviewSiteHash` string[]
          - `subject` string
        - `secondFollowUpSchedule` 'DAYS_2' | 'DAYS_5'
        - `secondFollowUpTemplate` EmailTemplateV4
          - `content` string
          - `fromEmail` string, email
          - `heading` string
          - `replyTo` string, email
          - `reviewSiteHash` string[]
          - `subject` string
        - `stats` CampaignStatV2[]
          - `name` 'emails_sent' | 'sms_sent' | 'invite_open_rate' | 'clicks_rate' | 'customer_exp_score'
          - `value` string
        - `numberOfFeedbacks` integer: Total number of feedbacks received

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)
