List Review Sites by Invite Hash (PUBLIC)

PUBLIC endpoint hit by recipients of the review-site invite email: lists a store's review sites identified solely by the invite hash, returning the same row shape as the authenticated list endpoint plus the store name/id.

Auth: Neither — no authentication (public group). Access is granted entirely by the {hash} path param, a hashid that must decode to [store_id, 15] with a positive store id. The store_id comes from the hash so a recipient can only ever see their own store's review sites. No role — there is no authenticated user.

Rate limit: 30 requests/min.

Request

  • Body (optional):
FieldTypeRequiredNotes
has_landing_pageinteger (0/1)no1 filters to rows with a non-empty landing_page_url.

Response{ data: [.] } resource collection plus sibling store_name and store_id keys. Each row matches the review-site listing shape (id, url, landing_page_url, url_status, connectionStatus, is_connected, lock_color, sendto_scrapper, display_as_connected, reviews_status, posting_status, has_url, error_code, error_title, error_reason, fix_sheet, last_scraped_at, connect_page_url, nested review_site). Returns 400 Invalid or expired token. for a bad hash, 404 Store not found when the decoded store is missing.

Path params

ParameterTypeRequiredNotes
hashstringRequiredMust match [a-zA-Z0-9]+.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
integer
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json