Site catalogue
Master review-site catalogue lookup, bulk credential updates across an account, Excel export / import, credential cleanup.
Master review-site catalogue lookup, bulk credential updates across an account, Excel export / import, credential cleanup. Account-owner / partner-admin setup surface.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
POST — 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).
POST — Bulk-sets username + password for one review site across every store under an account, enabling its scraper on each, and optionally persists the credentials so future stores inherit them.
GET — Get the saved review-site login (username only, never the password) stored at the company/account level for a given review site.
DELETE — Delete a saved company-level review-site login (a company_meta_data row of category review_site).
POST — Generate an Excel export of all review-site credentials for the stores under the given Account (bundle_id=3 company), stores the file on S3, and returns its public download URL.
POST — Upload a filled-in review-site credentials Excel file for an account. The endpoint validates its header row, stores it on S3, and emails a confirmation to the support address for back-office processing.
POST — Returns a paginated list of stores accessible to the authenticated user, each joined to full location, account, and geo detail plus the active store_plan (with plan features) and a generated connect_page_url.
Updated 9 days ago