Export locations to Excel

Overview

Generate an Excel export of all locations under the authenticated account, store it to S3, and return the public download URL.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/reports/excel/locations

Authentication

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

• Who can call it: Account tokens.

• The route is inside the authenticated group.

• Requires the user's company bundle_id === 3 (ACCOUNT); a non-account user gets 403.

• Scope is the caller's own company tree: store ids are validated against it.

Rate limit

• No rate limit.

Request

• No path/query/body params.

Response

• data.path (string) — public S3 URL of the generated .xlsx, keyed download/excel/<Y-m>/<timestamp>-<SafeBrandName>-Locations.xlsx.

200 Success · 200

{
  "data": {
    "path": "https://s3.amazonaws.com/your-bucket/download/excel/2026-05/1732540672-Acme-Brand-Locations.xlsx"
  }
}

Errors

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'