Get one site connection

Overview

Get the full details of one review site connection on a location.

Use this when you need everything about one site: URLs, posting status, when it was last collected, and any connection problem.

You'll need the store_review_site_id (the id from List a location's review sites).

Returns the connection, its review site, the location, and the latest review collection.

Prerequisites

A bearer token, or the invite hash from a connection link. See Authentication.
The connection's store_review_site_id.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

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

Authentication

Partner or Account token

The connection must be on a location inside your own account tree. A Partner token reaches any location under the partner; an Account token only its own account's locations. Otherwise 422.
Or, with no token: send the invite hash (the token from Send the business owner a connection link). The connection must be on the location the hash is for.

Rate limit

30 requests per minute, counted per client IP address. See Rate limits.

Request parameters

Parameter	In	Type	Required	Description
`storeReviewSiteId`	path	integer	Yes	The connection's id (`store_review_site_id`).
`hash`	query	string	No	The invite hash from a connection link. Use it instead of a token.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`store_review_site`	object	The connection.
`store_review_site.id`	integer	The connection's id (`store_review_site_id`).
`store_review_site.review_site_id`	integer	The review site's id.
`store_review_site.store_id`	integer	The location's id.
`store_review_site.external_id`	string or null	The location's id on the review site, for sites connected through their own API (e.g. Caring). Otherwise `null`.
`store_review_site.external_name`	string or null	The location's name on the review site, for sites connected through their own API. Otherwise `null`.
`store_review_site.google_location_id`	string or null	Google only: the Google location id. Otherwise `null`.
`store_review_site.google_account_id`	string or null	Google only: the Google account id. Otherwise `null`.
`store_review_site.google_place_id`	string or null	Google only: the Google place id. Otherwise `null`.
`store_review_site.review_site_url`	string or null	The site's review URL for this location. `null` when not set.
`store_review_site.url`	string or null	Same as `review_site_url`.
`store_review_site.landing_page_url`	string or null	The landing page URL: where review requests send customers to leave a review. `null` when not set.
`store_review_site.landing_page_url_updated`	string	Stored flag; `""` by default.
`store_review_site.missing_url`	string	Stored flag; `""` by default.
`store_review_site.logins_working`	string	Stored flag; `""` by default.
`store_review_site.created_at`	string	When the site was added to the location (ISO 8601).
`store_review_site.updated_at`	string	When the connection last changed (ISO 8601).
`store_review_site.username`	string or null	The saved username for the site, or `null`.
`store_review_site.password`	string or null	The saved password, encrypted. `null` when none is saved.
`store_review_site.is_widget`	boolean	Stored flag; `false` by default.
`store_review_site.url_status`	string	`enable` or `disable`. Whether the landing page URL is used in review requests.
`store_review_site.is_url_exist`	string	Stored flag; `""` by default.
`store_review_site.url_sort_order`	integer	Position of the site among the location's review-site buttons in review requests (lower first).
`store_review_site.sendto_scrapper`	string	`Y` when review collection is on, `N` when it's off.
`store_review_site.wants_to_respond`	boolean or null	The owner's answer on the connection page to "Do you want to respond to reviews?", or `null` if not answered.
`store_review_site.client_confirmed_at`	string or null	When the owner confirmed on the connection page that they added the manager (ISO 8601), or `null`.
`store_review_site.display_as_connected`	boolean	`true` when the site is set to show as connected without a live connection.
`store_review_site.other_detail`	string or null	Extra site-specific details as a JSON string (e.g. the BBB owner name and zip), or `null`.
`store_review_site.live_rating`	string or null	The location's rating on the site, or `null`.
`store_review_site.total_reviews`	string or null	The location's review count on the site, or `null`.
`store_review_site.connection_status`	string or null	The stored connection state, e.g. `connected` or `disconnected`, or `null`.
`store_review_site.disconnect_reason`	string or null	Why the site was disconnected, or `null`.
`store_review_site.error_code`	string or null	The connection problem's code, e.g. `E-002`, or `null`.
`store_review_site.rd_last_scraped_at`	string or null	When reviews were last collected (ISO 8601), or `null`.
`store_review_site.is_connected`	integer	`1` when connected, otherwise `0`.
`store_review_site.connectionStatus`	string	`Connected`, `Awaiting` or `Disconnected`.
`store_review_site.lock_color`	string	Status colour: `green` (connected), `orange` (awaiting) or `gray`.
`store_review_site.reviews_status`	string	Review collection: `streaming`, `offline` or `no_url`.
`store_review_site.posting_status`	string	Response posting: `active`, `in_progress`, `off`, `access_lost` or `offline`.
`store_review_site.has_url`	boolean	Whether the site has a review URL.
`store_review_site.error_title`	string or null	Short title of the problem, e.g. `Connection sign-in lost`. `null` when posting isn't blocked.
`store_review_site.error_reason`	string or null	What went wrong and how to fix it, in plain language.
`store_review_site.fix_sheet`	string	The next step to show: `none`, `pending`, `connect_url`, `enable_posting`, `oauth_reconnect` or `manager_invite`.
`store_review_site.last_scraped_at`	string or null	When reviews were last collected (ISO 8601), or `null`.
`store_review_site.connect_page_url`	string	This site's page in the Shout About Us web app (or your white-label domain), where the connection is set up.
`review_site`	object	The review site.
`review_site.id`	integer	The review site's id.
`review_site.name`	string	The review site's name, e.g. `Yelp`.
`review_site.link`	string	Where the owner signs in to the site. For Yelp and Caring, their business login page; otherwise the site's home page.
`review_site.review_site_button`	string	URL of the site's logo.
`review_site.review_site_color`	string	The site's brand colour, e.g. `#d32200`.
`review_site.max_rate`	integer	The highest rating on the site, e.g. `5`.
`review_site.status`	integer	Stored status flag of the review site.
`review_site.show`	boolean	Stored display flag of the review site.
`review_site.use_sau_scrapper`	string	Stored flag, `Y` or `N`.
`review_site.publisher`	string	The site's domain, e.g. `yelp.com`.
`review_site.logo`	string or null	A custom logo set for the site, or `null`.
`review_site.auth_type`	string or null	How the site connects: `oauth`, `cookie`, `credential`, `default`, `restapi`, or `null`. See List supported review sites.
`review_site.scraping_enabled`	boolean	Whether reviews can be collected from this site.
`review_site.posting_enabled`	boolean	Whether responses can be posted to this site.
`review_site.is_premium`	boolean	`true` when adding a manager on this site needs a paid business plan on the site.
`review_site.self_form_enabled`	string	`Y` when review requests for this site open the Shout About Us review form instead of the site's landing page. Otherwise `N`.
`review_site.email_on_reply`	string	Stored flag; `""`, `Y` or `N`.
`review_site.deleted_at`	string or null	Always `null` for a live review site.
`review_site.created_at`	string	When the review site was added (ISO 8601).
`review_site.updated_at`	string	When the review site last changed (ISO 8601).
`store`	object	The location.
`store.id`	integer	The location's id (`store_id`).
`store.name`	string	The location's name.
`store.storeId`	string	The location's label (by default its city).
`store.code`	string	The location's short code.
`store.slug`	string	The location's URL slug.
`store.created_at`	string	When the location was created (ISO 8601).
`store.status`	string	The location's status, e.g. `active`.
`store.use_sau_scrapper`	string	Stored flag; `""` by default.
`store.client_location_id`	string or null	Your own id for the location.
`store.company_id`	integer	The location's company id.
`store.company`	object	The location's address details.
`store.company.id`	integer	The location's company id.
`store.company.address`	string or null	Street address.
`store.company.zip`	string or null	Postal code.
`non_lde`	object	A fixed map of review site names to numbers, the same on every call (e.g. `"Vrbo": 7`).
`latest_review_pull`	object or null	The latest review collection for this connection, or `null` if there hasn't been one.
`latest_review_pull.status`	string	`pending`, `running`, `complete`, `no_new` (no new reviews) or `failed`.
`latest_review_pull.time`	string	When it finished, or when it started if it hasn't finished (ISO 8601).
`latest_review_pull.reviews_pulled`	integer	How many reviews it collected.
`latest_review_pull.error_message`	string or null	Why it failed, in plain language, or `null`.

Response payload

{
  "data": {
    "store_review_site": {
      "id": 8782,
      "review_site_id": 1,
      "store_id": 3007,
      "external_id": null,
      "external_name": null,
      "google_location_id": null,
      "google_account_id": null,
      "google_place_id": null,
      "review_site_url": null,
      "url": null,
      "landing_page_url": null,
      "landing_page_url_updated": "",
      "missing_url": "",
      "logins_working": "",
      "created_at": "2026-09-23T10:43:45.000000Z",
      "updated_at": "2026-10-01T08:04:22.000000Z",
      "username": "[email protected]",
      "password": "<encrypted-password>",
      "is_widget": false,
      "url_status": "disable",
      "is_url_exist": "",
      "url_sort_order": 0,
      "sendto_scrapper": "Y",
      "wants_to_respond": null,
      "client_confirmed_at": null,
      "display_as_connected": false,
      "other_detail": null,
      "live_rating": null,
      "total_reviews": null,
      "connection_status": null,
      "disconnect_reason": null,
      "error_code": null,
      "rd_last_scraped_at": null,
      "is_connected": 0,
      "connectionStatus": "Disconnected",
      "lock_color": "gray",
      "reviews_status": "no_url",
      "posting_status": "off",
      "has_url": false,
      "error_title": null,
      "error_reason": null,
      "fix_sheet": "connect_url",
      "last_scraped_at": null,
      "connect_page_url": "https://production.shoutaboutus.com/connect-review-sites/5oogfx/edit-site/3007/Yelp/8782/"
    },
    "review_site": {
      "id": 1,
      "name": "Yelp",
      "link": "https://biz.yelp.com/login?return_url=%2F%3Ffwp%3Dtrue&utm_medium=y4bweb&utm_source=y4bweb-header&utm_content=login-cta-header-btn&utm_campaign=claim-flow-y4bweb",
      "review_site_button": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/yelp_ic.png",
      "review_site_color": "#d32200",
      "max_rate": 5,
      "status": 0,
      "show": true,
      "use_sau_scrapper": "Y",
      "publisher": "yelp.com",
      "logo": null,
      "auth_type": "cookie",
      "scraping_enabled": true,
      "posting_enabled": true,
      "is_premium": false,
      "self_form_enabled": "N",
      "email_on_reply": "",
      "deleted_at": null,
      "created_at": "2015-05-26T09:18:10.000000Z",
      "updated_at": "2020-05-04T02:44:57.000000Z"
    },
    "store": {
      "id": 3007,
      "name": "Acme Coffee",
      "storeId": "Sydney",
      "code": "g26g",
      "slug": "acme-coffee",
      "created_at": "2026-09-23T10:43:44.000000Z",
      "status": "active",
      "use_sau_scrapper": "",
      "client_location_id": "docs-test-loc-001",
      "company_id": 5995,
      "company": {
        "id": 5995,
        "address": "1 George St",
        "zip": "2000"
      }
    },
    "non_lde": {
      "ApartmentGuide": 1,
      "Apartments": 1,
      "CarGurus": 1,
      "Caring": 1,
      "Cars": 1,
      "SeniorAdvisor": 1,
      "Care": 14,
      "Agoda": 7,
      "OptSpot": 7,
      "Lawcrossing": 7,
      "Rent": 7,
      "Zillow": 1,
      "Carfax": 7,
      "Gayot": 7,
      "Grubhub": 7,
      "Ubereats": 1,
      "Doordash": 1,
      "Thedyrt": 7,
      "Hipcamp": 7,
      "A Place For Mom": 7,
      "Vrbo": 7
    },
    "latest_review_pull": null
  }
}

Examples

Success payload

See Response payload.

Error payload

422 Connection outside your tree

{
  "message": "The selected store review site id does not belong to your company hierarchy.",
  "errors": {
    "store_review_site_id": [
      "The selected store review site id does not belong to your company hierarchy."
    ]
  }
}

422 Connection doesn't exist

{
  "message": "The selected store review site id is invalid. (and 1 more error)",
  "errors": {
    "store_review_site_id": [
      "The selected store review site id is invalid.",
      "The selected store review site id does not belong to your company hierarchy."
    ]
  }
}

422 Invalid hash

{
  "message": "Invalid or expired token.",
  "errors": {
    "hash": [
      "Invalid or expired token."
    ]
  }
}

429 Too many requests

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

Status	Meaning
`200`	The connection.
`401`	No token and no `hash`, or the token is expired or invalid.
`422`	The connection doesn't exist or is outside your tree, or the `hash` is invalid or for another location.
`429`	Rate limit exceeded.
`500`	Unexpected server error.

Example request

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