Export locations to Excel

Overview

Download every location under your account as a spreadsheet.

Use this for offline review or a migration.

You'll need an account token.

Returns a link to the file. The sheet has one row per location: Location ID, Store Name, Store ID, Address, Country Code, State Code, City Name, Zip Code and Business Phone Number.

Prerequisites

• An Account bearer token. See Authentication.

Base URL

Endpoint

GET /api/v1/reports/excel/locations

Authentication

Account token

• Only Account tokens can call it. Any other token gets 403.
• It covers your own account's locations. There is no id to send.

Rate limit

60 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "data": {
    "path": "https://d2ny6zb7otrnhl.cloudfront.net/download/excel/2026-10/1790812800-SAU_Docs_Test-Locations.xlsx"
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Not an Account token

{
  "message": "This action is unauthorized."
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/excel/locations" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'