List a location's review sites

Get every review site on a location with the state of each connection: whether it has a review URL, whether collection is on, and whether posting is authorized. Use this to see what's set up before making changes, or to build a connection-status view in your own dashboard. It's also where you get each connection's store_review_site_id. Send the store_id or your client_location_id. Returns one entry per site with its IDs, URLs, and status; Google comes first, then Yelp and Facebook, then the other sites.

Prerequisites: a bearer token and the location's store_id (or your client_location_id for it).

Authentication: Partner or Account token. The location must be inside your own account tree (a Partner token reaches any location under the partner, an Account token only its own account's locations); otherwise 422.

Rate limit: none.

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

The location. Required unless you send client_location_id. Must exist and be inside your account tree.

string
length ≤ 255

Your own id for the location, used instead of store_id. Up to 255 characters.

integer
enum
Defaults to 0

1: only sites that have a landing page URL. 0 or left out: all sites.

Allowed:
integer
enum
Defaults to 1

0: skip the connection check for a faster call; the connection fields come back empty (connectionStatus "", the card-state fields null). 1 or left out: include them.

Allowed:
string
enum

review_site. Accepted, but the order is fixed (see Overview).

Allowed:
string
enum

asc or desc. Accepted, but the order is fixed (see Overview).

Allowed:
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