Review-site dropdown

Overview

GET variant of the same route backing the review-site dropdown — returns the selectable review-site catalog (value/label pairs) for an account. The catalog is the union of review sites on the plans assigned to the account's account(s), with hipages pinned first, then Google (44) and Yelp (1). Legacy Google site id 52 is always excluded.

Prerequisites

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

Base URL

Endpoint

GET /api/v1/account/reviewsite/list

Authentication

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

• Who can call it: Partner and Account tokens.

• Mounted under the role-agnostic /account/* prefix (top-level authentication group).

• Target account comes from company_id (query param here) or falls back to the auth user's own person.company_id.

• company_id must sit inside your own account tree. A Partner (bundle_id=1) may target any company in its tree, while an Account (bundle_id=3) reaches only its own part of the account tree.

Rate limit

• No rate limit.

Query parameters

• Query: company_id (integer, optional) — nullable; must exists in the account's id and pass an ownership check. Defaults to the auth user's person.company_id when you omit it.
• Query: except_review_site_id (array, optional) — nullable|array of review-site ids to exclude; each element required when the param is present.

Response

• data.status (string) — always "success".
• data.response (array) — list of review sites; [] when no plans/review sites resolve. Each item:
• value (integer) — review site id.
• label (string) — review site name; id 44 force-labelled "Google", otherwise the review site's name.

200 OK · 200

{
  "data": {
    "status": "success",
    "response": [
      { "value": 44, "label": "Google" },
      { "value": 1, "label": "Yelp" }
    ]
  }
}

Errors

Example request

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