Export review-site setup to Excel

Overview

Generate an Excel export of review-site credentials for the stores under the given Account (bundle_id=3 company), excluding review sites 9 and 52. Stores the file on S3, and returns its public download URL.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

POST /api/v1/store-review-site/excel/list

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• The target must sit inside your own account tree, keyed on account_id. It must be a non-deleted company row with bundle_id=3. It must place it at or under the auth user's company.

• A Partner user can therefore export any account in their tree. An Account user can only export their own account.

• The exported store set (review sites 9 and 52 excluded).

Rate limit

• No rate limit.

Request body

• Body:

{
  "account_id": 10
}

Response

• data.path (string) — public S3/CloudFront URL of the generated .xlsx file (key pattern download/excel/YYYY-MM/{timestamp}-ReviewSiteData.xlsx). The workbook columns are Location Name, Address, City, State, Zip, SAU Code, Review Site, Url, Username, Password (decrypted), Landing Page URL.

200 Success · 200

{
  "data": {
    "path": "https://d2ny6zb7otrnhl.cloudfront.net/download/excel/2026-06/1782122214-ReviewSiteData.xlsx"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/excel/list" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"account_id": 10}'