Show single store-review-site

Overview

Get the full detail bundle for one store-review-site row: the pivot record, its review-site, its store (+company), the non-LDE site map, hipages flag, and the latest cadence pull summary. Drives the edit-site page.

Prerequisites

  • A bearer token or an invite hash. Callable with Partner and Account tokens.
  • The storeReviewSiteId of the record you are targeting.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/store-review-site/show/{storeReviewSiteId}

Authentication

Choose one of the following:

  • Bearer token: Include a bearer token in the Authorization: Bearer <bearer-token> header. Callable with Partner and Account tokens. An authenticated user reaches the row only if store_review_site_id (taken from the {id} path) passes an ownership check (Partner or Account hierarchy). It differs per role only by reachable scope. A Partner sees any row under its tree. An Account sees only its account's.
  • Invite hash: Pass a hash query parameter (no token required), and the row must belong to that store.

Rate limit

  • 30 requests/min.

Path parameters

ParameterTypeRequiredDescription
storeReviewSiteIdstringRequiredIdentifier for the record you are targeting.

Query parameters

  • Query: hash (string, optional) — invite hashid; grants tokenless access when it encodes this row's store.

Response

  • data.store_review_site (object) — the pivot row plus connection-state fields folded in (isConnected + ): includes id, review_site_id, store_id, review_site_url, url, landing_page_url, username, password (re-encrypted for transport), sendto_scrapper, display_as_connected, connection_status, disconnect_reason, error_code, is_connected, connectionStatus, lock_color, reviews_status, posting_status, has_url, error_title, error_reason, fix_sheet, last_scraped_at, connect_page_url, etc. (Caring/BBB rows also carry external_id/external_name.)
  • data.review_site (object) — id, name, link, review_site_button, auth_type, scraping_enabled, posting_enabled, etc.
  • data.store (object) — id, name, storeId, company_id, nested company (id, address, zip, client_account_id).
  • data.is_hipages_partner (bool); non_lde (object map of site → id); latest_review_pull, has_completed_pull (bool) (object|null) — status, time, reviews_pulled, error_message.

200 Success · 200

{
  "data": {
    "store_review_site": {
      "id": 5,
      "review_site_id": 44,
      "store_id": 2,
      "review_site_url": "https://maps.google.com/...",
      "url": "https://maps.google.com/...",
      "landing_page_url": "https://search.google.com/local/writereview?placeid=ChIJ...",
      "username": null,
      "password": null,
      "sendto_scrapper": "N",
      "connection_status": "Disconnected",
      "is_connected": 0,
      "reviews_status": "offline",
      "posting_status": "offline",
      "has_url": true,
      "fix_sheet": "oauth_reconnect",
      "connect_page_url": "https://production.shoutaboutus.com/connect-review-sites/xxxxx/edit-site/xxx/Google/xxx/"
    },
    "review_site": {
      "id": 44,
      "name": "Google",
      "auth_type": "oauth",
      "scraping_enabled": true,
      "posting_enabled": true
    },
    "store": {
      "id": 2,
      "name": "Demo Brew",
      "storeId": "Alameda County",
      "company_id": 7,
      "company": {
        "id": 7,
        "address": "123 Main St",
        "zip": "92014",
        "client_account_id": null
      }
    },
    "is_hipages_partner": true,
    "has_completed_pull": true,
    "non_lde": {
      "Vrbo": 7
    },
    "latest_review_pull": {
      "status": "no_new",
      "time": "2026-06-15T13:41:47.000000Z",
      "reviews_pulled": 0,
      "error_message": null
    }
  }
}

Errors

StatusMeaning
401The bearer token is missing, expired, or invalid
422The request failed validation — the response names the fields
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/show/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?