FAQ & widgets
Account self-service: company FAQ blocks, testimonials, gallery images, and review widgets.
Account self-service: company FAQ blocks, testimonials, gallery images, and review widgets.
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
GET — Get the immediate child companies (accounts/locations) directly under the authenticated user's own company, formatted as value/label option pairs for dropdowns.
GET — Overall location ranking for the selected window (default last 12 months): up to 10 store locations ranked and graded by review count, response rate, and average rating (for hipages stores, spanning reviews from all connected sites).
POST — Upload one or more image files to S3 (under account/images/{type}) and creates an Image row per file for the company, returning the saved records with public S3 URLs.
POST — Returns a paginated list of widgets scoped to a single store (store_id) or an account company and its child companies (company_id), joined to widget type, store, and company-account names, with optional search/sort.
POST — Create a new widget, or updates an existing one when you supply unique_id.
Updated 9 days ago