List review sites for a store

List every review site configured for a store, each with its URL, scraper flag, connection card-state and review-site metadata — drives the store's connection/listing page.

Auth: Both — authentication. The store is targeted by store_id OR client_location_id, and an ownership check confirms the store sits in the auth user's company hierarchy. Partners reach any store under their tree; Account users only their own account's stores.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
store_idintegerrequired without client_location_idMust be an existing location and belong to the caller.
client_location_idstringoptionalMax 255; partner-owned stable id, resolved to store_id server-side; an ownership check.
has_landing_pageinteger (0/1)optional1 filters to rows that have a non-empty landing_page_url.
check_connectioninteger (0/1)optional0 short-circuits connection resolution (empty card-state) for a cheaper call.
sort_fieldstring (review_site)optionalAccepted but listing is ordered by a fixed FIELD priority.
sort_bystring (asc/desc)optional

Response{ data: [.] } resource collection plus a sibling store_name key.

  • data[] (array) — each row: id, url, landing_page_url, created_at, 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, and nested review_site (id, name, publisher, link, review_site_icon, review_site_color, self_form_enabled, auth_type, scraping_enabled, posting_enabled, keywords).
  • store_name (string) — top-level, store name with optional - {storeid} suffix.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
integer
Response

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