younifyd
Menu

Retrieve All Reviews

Retrieve all reviews

GET/v1/apps/{app_key}/reviews

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Retrieve All Reviews action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveAllReviews.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

Query parameters

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](https://apidocs.yotpo.com/reference#yotpo-authentication) to learn how to generate your utoken.

since_idstring

Lowest ID of the returned reviews

since_datestring (date)

Earliest creation date of returned reviews

since_updated_atstring (date)

Earliest update date of returned reviews

countstring

Number of reviews to return

pagestring

Page number to return reviews for

deletedboolean

Include unpublished reviews

user_referencestring

Filter by user reference

idstring

The ID of the review in Yotpo

Response

Returns 200 with an object. Read it in later steps with {{retrieveAllReviews.response.data.<field>}}.

reviewsarray<object>
idinteger

Default 0

titlestring
contentstring
scoreinteger

Default 0

votes_upinteger

Default 0

votes_downinteger

Default 0

created_atstring
updated_atstring
sentimentnumber

Default 0

skustring
namestring
emailstring
reviewer_typestring
deletedboolean

Default true

user_referenceany
is_incentivizedboolean

Default true

incentive_typestring
json
{
  "reviews": [
    {
      "id": 34789515,
      "title": "GREAT shirts",
      "content": "I now have several of these shirts and they are great. Great quality and look. My only minor complaint is that I have had one or two that have been SLIGHTLY on the small side. That said, their order process is easy and the product is great I will continue to buy most of my shirts from them.",
      "score": 4,
      "votes_up": 0,
      "votes_down": 0,
      "created_at": "2016-12-27T14:43:58.000Z",
      "updated_at": "2017-04-13T18:56:19.000Z",
      "sentiment": 0.963555,
      "sku": "1",
      "name": "Robert S.",
      "email": "robsmith@email.com"
    }
  ]
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.