Sign in

v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Review by Review ID

Retrieve a specific review by review_id.

get/v2/{account_id}/reviews/{review_id}?access_token={access_token}

Path parameters

account_idstring required

Your account's API app key

review_idstring required

The review_id. Can be found using All Reviews

Query parameters

access_tokenstring required

Your Yotpo access token. Click here to learn how to generate one

include_nestedboolean

include_nested data to return nested user data

include_site_reviewsboolean

Include site reviews in addition to product reviews

include_unpublished_reviewsboolean

Pass a value of true to get all reviews including unpublished reviews. Pass a value of false (default) to get just the published reviews.

Response

200

OR

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "review": {
    "review": {
      "id": "3021",
      "score": 5,
      "votes_up": 1,
      "content": "Best sandal ever!",
      "title": "Best sandal ever!",
      "created_at": "2012-11-29T12:49:19.000Z",
      "user_id": 2245,
      "product_id": 1802,
      "published": true,
      "order_id": 10456345,
      "external_order_id": "1045"
    }
  }
}