Returns the selectable review-site catalog (value/label pairs) available to an account — the union of review sites attached (via plan_review_sites) to the plans assigned to the account's account(s) — with hipages pinned first, then Google (44) and Yelp (1). The legacy "Google" site id 52 is always excluded.
Auth: Both — authentication under the role-agnostic /account/* prefix (top-level authentication group). Target account is taken from body company_id, falling back to the auth user's own person.company_id. The company_id must sit inside your own account tree, which resolves account (bundle_id=3) directly and walks the partner (bundle_id=1) tree, so a Partner may pass any company in its hierarchy while an Account reaches only its own part of the account tree.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
company_id | integer | optional | nullable; must exists in the account's id AND pass an ownership check (must be inside the caller's company hierarchy). If omitted, defaults to the auth user's person.company_id. |
except_review_site_id | array | optional | `nullable |
except_review_site_id.* | integer | required_with | each element required when except_review_site_id is present. |
Response — { data. } envelope.
data.status(string) — always"success".data.response(array) — list of review sites; empty[]when the account's accounts have no plans or those plans have no review sites. Each item:value(integer) — review site id.label(string) — review site name; id 44 is force-labelled"Google", otherwise the review site'sname.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||