---
agentTools:
  projectIndex: https://developers.etrusted.com/llms.txt
---

# Get a review by ID

This endpoint retrieves a review by its ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Reviews API",
    "description": "Review application external APIs",
    "version": "1.0.1"
  },
  "servers": [
    {
      "url": "https://api.etrusted.com",
      "description": "public API"
    }
  ],
  "paths": {
    "/reviews/{reviewId}": {
      "get": {
        "summary": "Get a review by ID",
        "operationId": "getReview",
        "tags": [
          "Endpoints"
        ],
        "description": "This endpoint retrieves a review by its ID.\n",
        "parameters": [
          {
            "name": "Authorization",
            "schema": {
              "type": "string"
            },
            "in": "header",
            "required": true,
            "description": "An OAuth2 authorization header with an access token, see [OAuth2](/reference/authentication-2)"
          },
          {
            "in": "path",
            "name": "reviewId",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The review ID.\n\nExample: `rev-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx`\n"
          }
        ],
        "responses": {
          "200": {
            "description": "The review with the specified ID.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerReviewResponseDto"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CustomerReviewResponseDto": {
        "description": "A single retrieved customer review.",
        "type": "object",
        "required": [
          "_object",
          "id",
          "accountRef",
          "channelRef",
          "rating",
          "title",
          "comment",
          "createdAt",
          "updatedAt",
          "submittedAt",
          "state",
          "type",
          "questionnaire"
        ],
        "properties": {
          "_object": {
            "type": "string",
            "description": "The object type of this response object, which is `CustomerReview`.",
            "example": "CustomerReview"
          },
          "id": {
            "type": "string",
            "description": "The customer review UUID.",
            "example": "rev-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
          },
          "accountRef": {
            "type": "string",
            "description": "A UUID as account reference.",
            "example": "acc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
          },
          "channelRef": {
            "type": "string",
            "description": "A UUID as channel reference.",
            "example": "chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
          },
          "inviteRef": {
            "type": "string",
            "description": "A UUID as invite reference.",
            "example": "inv-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
          },
          "rating": {
            "type": "number",
            "description": "The star rating.\n\nThe value ranges from `1.0` to `5.0`.\n",
            "example": 4.6
          },
          "title": {
            "type": "string",
            "description": "A title headline for this customer review.",
            "example": "Great experience"
          },
          "comment": {
            "type": "string",
            "description": "The review text for this customer review.",
            "example": "Everything went well. Very helpful staff!"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the customer review was stored initially, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats. This date will be after `submittedAt` for imported reviews.",
            "example": "2018-02-01T17:09:41.790Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the customer review was last modified, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
            "example": "2018-02-01T17:09:41.790Z"
          },
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the customer review was submitted by the reviewer, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
            "example": "2018-02-01T17:09:41.790Z"
          },
          "feedbackType": {
            "$ref": "#/components/schemas/FeedbackType"
          },
          "state": {
            "$ref": "#/components/schemas/ReviewState"
          },
          "type": {
            "$ref": "#/components/schemas/Type"
          },
          "verificationType": {
            "$ref": "#/components/schemas/VerificationType"
          },
          "reply": {
            "$ref": "#/components/schemas/CustomerReviewReplyDto"
          },
          "customer": {
            "type": "object",
            "description": "This object holds information about the customer who wrote the review.",
            "properties": {
              "firstName": {
                "type": "string",
                "description": "The first name of the customer.",
                "example": "John"
              },
              "lastName": {
                "type": "string",
                "description": "The last name of the customer.",
                "example": "Doe"
              },
              "fullName": {
                "type": "string",
                "description": "The full name of the customer.",
                "example": "John Doe"
              },
              "email": {
                "type": "string",
                "description": "An email address of the customer.",
                "example": "john.doe@example.com"
              },
              "mobile": {
                "type": "string",
                "description": "A mobile phone number of the customer.",
                "example": "+123456789"
              }
            }
          },
          "transaction": {
            "type": "object",
            "description": "The transaction associated with the customer review.",
            "required": [
              "reference"
            ],
            "properties": {
              "reference": {
                "type": "string",
                "description": "The transaction reference, e.g. `ORDER-12345`.",
                "example": "ORDER-12792"
              },
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time when the transaction took place, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
                "example": "2018-01-04T12:09:50.722Z"
              }
            }
          },
          "event": {
            "type": "object",
            "description": "The event object that is associated with the customer review.",
            "required": [
              "id",
              "type"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "The event UUID.",
                "example": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
              },
              "type": {
                "type": "string",
                "description": "The [event type](https://developers.etrusted.com/glossary.html#event-type).",
                "example": "checkout"
              }
            }
          },
          "metadata": {
            "type": "object",
            "description": "The `metadata` object is a collection of user-defined data added to the customer review.",
            "example": {
              "customParam1": "customVal1",
              "customParam2": "customVal2"
            }
          },
          "surveyData": {
            "type": "object",
            "description": "The `surveyData` object holds custom response data from additional questions from *eTrusted* questionnaires.\n",
            "example": {
              "responseParam1": "responseVal1",
              "responseParam2": "responseVal2"
            }
          },
          "questionnaire": {
            "type": "object",
            "description": "The questionnaire that was used to collect the customer review.",
            "required": [
              "id",
              "locale",
              "templateRef"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "The questionnaire UUID.",
                "example": "qre-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
              },
              "locale": {
                "type": "string",
                "description": "The questionnaire [locale](#tag/Locales).",
                "example": "en_GB"
              },
              "templateRef": {
                "type": "string",
                "description": "A UUID as questionnaire template reference.",
                "example": "qrt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
              }
            }
          },
          "hasAttachments": {
            "type": "boolean",
            "description": "This indicates if the whether the customer review has attachments, such as images.\n"
          },
          "additionalInformation": {
            "type": "object",
            "description": "This object containts all of the additional information that is stored with the customer review.",
            "properties": {
              "veto": {
                "type": "object",
                "description": "The veto of this customer review.",
                "required": [
                  "createdAt",
                  "reason",
                  "comment",
                  "ticketId"
                ],
                "properties": {
                  "createdAt": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The date and time when the veto was created, in the [ISO 8601](iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ.",
                    "example": "2018-02-01T17:09:41.790Z"
                  },
                  "comment": {
                    "type": "string",
                    "description": "The comment in the ticket that was created internally at *Trusted Shops* for this veto.",
                    "example": "Example comment"
                  },
                  "reason": {
                    "type": "string",
                    "description": "The reason for this veto.\n\nThis string may only have the following values:\n\n* `UNTRUTHFUL`\n* `ABUSIVE`\n* `VIOLATES_THE_TERMS_OF_USE`\n",
                    "x-extensible-enum": [
                      "UNTRUTHFUL",
                      "ABUSIVE",
                      "VIOLATES_THE_TERMS_OF_USE"
                    ]
                  },
                  "ticketId": {
                    "type": "string",
                    "description": "A reference to the ticket that was created internally at *Trusted Shops* for this veto.\nThe ID is a sequence of six digits.\n",
                    "example": "123123"
                  }
                }
              },
              "attachments": {
                "description": "Holds information about the attachments of this customer review.",
                "properties": {
                  "images": {
                    "type": "array",
                    "description": "This is a list of image objects.\n\nEach image object represents a single image attached to this customer review.\n",
                    "items": {
                      "type": "object",
                      "required": [
                        "id",
                        "extensions",
                        "urlOriginal",
                        "pathOriginal",
                        "pathThumbnail",
                        "pathLarge"
                      ],
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "The attachment UUID.\n",
                          "example": "atc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
                        },
                        "extensions": {
                          "type": "string",
                          "description": "The extension of the image.\n",
                          "example": "png"
                        },
                        "urlOriginal": {
                          "type": "string",
                          "description": "The url to the original image in original size.\n",
                          "example": "https://attachments.etrusted.koeln/attachments/id/more/directories/image.png"
                        },
                        "pathOriginal": {
                          "type": "string",
                          "description": "The path to the original image in original size.\n",
                          "example": "/attachments/id/more/directories/image.png"
                        },
                        "pathThumbnail": {
                          "type": "string",
                          "description": "The path to the thumbnail image.\n",
                          "example": "/attachments/id/more/directories/image.png"
                        },
                        "pathLarge": {
                          "type": "string",
                          "description": "The path to the image in large size.\n",
                          "example": "/attachments/id/more/directories/image.png"
                        }
                      }
                    }
                  }
                }
              },
              "originalReview": {
                "type": "object",
                "description": "This object contains the original review, in case the consumer edited their review via our B2C world.",
                "properties": {
                  "rating": {
                    "type": "number",
                    "description": "The star rating before the changes.\n\nThe value ranges from `1.0` to `5.0`.\n"
                  },
                  "title": {
                    "type": "string",
                    "description": "A title headline for this customer review before any changes.",
                    "example": "Great experience"
                  },
                  "comment": {
                    "type": "string",
                    "description": "The review text for this customer review before any changes.",
                    "example": "Everything went well. Very helpful staff!"
                  },
                  "reply": {
                    "$ref": "#/components/schemas/CustomerReviewReplyDto"
                  }
                }
              }
            }
          },
          "product": {
            "$ref": "#/components/schemas/CustomerReviewResponseProductDto"
          },
          "editedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the customer review was last edited by the consumer via our B2C world, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats. Will not be present in the response when the review was never edited by the consumer.",
            "example": "2018-02-01T17:09:41.790Z"
          },
          "originalReview": {
            "$ref": "#/components/schemas/OriginalReview"
          }
        }
      },
      "CustomerReviewResponseProductDto": {
        "description": "The product data retrieved with the customer review.",
        "type": "object",
        "required": [
          "id",
          "sku",
          "name",
          "url"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The product UUID.\n",
            "example": "prt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
          },
          "sku": {
            "type": "string",
            "description": "The Stock Keeping Unit is a specific article number of the product, most often assigned by a specific retail shop as a scannable bar code.\nIt lets the shops track movement of inventory.\nThe SKU must be unique and usually consists of about 8 characters.\n",
            "example": "1234-TS-WH-M"
          },
          "mpn": {
            "type": "string",
            "description": "The Manufacturer Part Number is an identifier for a product by the manufacturer if applicable.\nIn some cases it can serve as a substitute for the GTIN.\n",
            "example": "23687778"
          },
          "gtin": {
            "type": "string",
            "description": "The GTIN is a unique string that identifies the product globally.\nA GTIN can be an ISBN, an EAN, and much more.\nRefer to [gtin.info](https://www.gtin.info/).\n",
            "example": 1234567890123
          },
          "name": {
            "type": "string",
            "description": "The product name contains information about a product that is associated with the customer review.\nE.g. `Specialbrand T-Shirt White M`.\n",
            "example": "Specialbrand T-Shirt White M"
          },
          "url": {
            "type": "string",
            "description": "The link to the product detail page in your online shop or public catalog (e.g. http://www.specialbrandshop.com/article123-TS-WH-M/).\n",
            "example": "http://www.specialbrandshop.com/article123-TS-WH-M/"
          },
          "imageUrl": {
            "type": "string",
            "description": "The link to the product image of the product.\neTrusted shows a picture of the product to the customer who wants to write a review.\nThis makes it easier for customers to remember the purchase and recognize the product.\n",
            "example": "https://www.specialbrandshop.com/article123-TS-WH-M/image.jpg"
          },
          "brand": {
            "type": "string",
            "description": "The brand of the product.\nA product can only have one brand.\n",
            "example": "specialbrand"
          }
        }
      },
      "CustomerReviewReplyDto": {
        "type": "object",
        "description": "The reply to the customer review, written by the channel owner.",
        "required": [
          "createdAt",
          "updatedAt",
          "comment"
        ],
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the reply was stored initially, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
            "example": "2018-02-01T17:10:42.733Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the reply was last updated, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
            "example": "2018-02-01T17:11:33.121Z"
          },
          "comment": {
            "type": "string",
            "description": "The text message of the reply.",
            "example": "We appreciate your feedback."
          },
          "sendNotification": {
            "type": "boolean",
            "description": "Indicates whether the reviewer is notified about the reply by *eTrusted* or not."
          }
        }
      },
      "OriginalReview": {
        "type": "object",
        "description": "This is the initial unedited customer review. This object will not change when the review gets edited.",
        "properties": {
          "rating": {
            "type": "number",
            "description": "The original core review star rating. The value ranges from 1 to 5.",
            "example": "4"
          },
          "comment": {
            "type": "string",
            "description": "The original review comment. It is a string of up to 4000 characters.",
            "example": "It was a very good experience. The service team is very friendly and the prices are good. I can only recommend this store."
          },
          "title": {
            "type": "string",
            "description": "The original review title.",
            "example": "It was a very good experience."
          },
          "reply": {
            "type": "object",
            "description": "The original reply to the customer review, written by the channel owner.",
            "properties": {
              "replyComment": {
                "type": "string",
                "description": "The text message of the reply.",
                "example": "We appreciate your feedback."
              },
              "replyCreatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time when the reply was stored initially, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
                "example": "2018-02-01T17:10:42.733Z"
              },
              "replyUpdatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time when the reply was last updated, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats.",
                "example": "2018-02-01T17:11:33.121Z"
              }
            }
          }
        }
      },
      "ReviewState": {
        "type": "string",
        "description": "The state of the customer review when the API request was processed.\nSee [our glossary entry](https://developers.etrusted.com/glossary.html#review) for more information on review states.\n",
        "enum": [
          "SUBMITTED",
          "APPROVED",
          "REJECTED",
          "MODERATION",
          "DISCARDED"
        ],
        "example": "APPROVED"
      },
      "FeedbackType": {
        "type": "string",
        "description": "The feedback type which is determined by the customer review title, comment and rating.\nThe type is `REVIEW` unless either the comment or the rating are missing. In that case it is `STATEMENT`.\n",
        "enum": [
          "REVIEW",
          "STATEMENT"
        ]
      },
      "VerificationType": {
        "type": "string",
        "description": "Specifies whether the collection method in combination with the provider/source can be trusted. A Review will be VERIFIED unless it comes from an external import by an account that is not explicitly marked as verified.\n",
        "enum": [
          "VERIFIED",
          "UNDEFINED"
        ]
      },
      "Type": {
        "type": "string",
        "description": "The customer review type.\n\nA service review is a review for a channel as a whole, e.g. a shop or a store, while a product review is tied to a single product.\n",
        "enum": [
          "SERVICE_REVIEW",
          "PRODUCT_REVIEW"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 83,
      "2": 142,
      "3": 29,
      "4": 5,
      "5": 189,
      "6": 222,
      "7": 0,
      "8": 77,
      "9": 152,
      "10": 142,
      "11": 231
    }
  }
}
```