--- title: "Get a list of reviews" method: GET path: "/reviews" tags: ["Endpoints"] --- # Get a list of reviews `GET /reviews` This endpoint retrieves reviews for a specific channel, a set of channels or for your entire account. The result set can be modified using a set of filters. Query parameters can be added to the request, separated by `&`. Conceptually, there are two types of categories for the query parameters: actual filter parameters on the one hand, `channels`, `rating`, `submittedAfter` and `submittedBefore`, and pagination parameters on the other, `count`, `after` and `before`. See our guide on [paginating response data](/reference/pagination) for more information. > **Custom Widget Implementation:** Please note the response may include rejected reviews when using a custom widget. To prevent these from appearing, filter out reviews with the `status` attribute set to `REJECTED`. ## Query parameters - `channels` string[] - `after` string - `before` string - `submittedAfter` string - `submittedBefore` string - `count` integer - `rating` integer[] - `status` string[] - `type` string[] - `hasReply` boolean - `additionalInformation` string[] - `ignoreStatements` boolean - `query` string - `sku` string[] - `orderBy` string ## Headers - `Authorization` string, required ## Response `200` The list of reviews for the given channels or all channels. - CustomerReviewListResponseDto — The list of retrieved reviews. - `totalElements` integer, required — Deprecated. Use review/count. The value will return 0. - `paging` object, required — The paging object holds pagination information for the reviews retrieved via this API. - `count` integer, required — This is the number of reviews displayed in one page of the pagination. Note that this number might be lower than the `count` number in the request. This happens when the last page is reached. For example: A total number of 105 reviews are displayed in chunks of 20 reviews per page. The sixth and last page will only have 5 reviews. The `count` property will hold the value `5`. - `cursor` object, required — The cursor object contains information to navigate to the previous and next pages in a subsequent request. - `before` string, required — This is a review ID to retrieve the previous page in the pagination. - `after` string — This is a review ID to retrieve the next page in the pagination. It is empty if it is the last page in the pagination. - `links` object, required — Links to the previous and next pages in the pagination. Note that the links contain the exact filter parameters that were used in the request (`rating`, `submittedBefore`, `submittedAfter`). This makes sure that the pagination is always relative to the same filter in subsequent requests. If developers build URLs themselves using `after`, `before`, and the matching information inside the `cursor` object, they may need to ensure to recreate the same filter as well. - `previous` string, required — The link to the previous page in the pagination. - `next` string — The link to the next page in the pagination. It is empty if it is the last page in the pagination. - `items` CustomerReviewResponseDto[], required — This is the list of review objects. Each `item` object represents a single retrieved review. - `_object` string, required — The object type of this response object, which is `CustomerReview`. - `id` string, required — The customer review UUID. - `accountRef` string, required — A UUID as account reference. - `channelRef` string, required — A UUID as channel reference. - `inviteRef` string — A UUID as invite reference. - `rating` number, required — The star rating. The value ranges from `1.0` to `5.0`. - `title` string, required — A title headline for this customer review. - `comment` string, required — The review text for this customer review. - `createdAt` string, date-time, required — 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. - `updatedAt` string, date-time, required — 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. - `submittedAt` string, date-time, required — 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. - `feedbackType` 'REVIEW' | 'STATEMENT' — The feedback type which is determined by the customer review title, comment and rating. The type is `REVIEW` unless either the comment or the rating are missing. In that case it is `STATEMENT`. - `state` 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'MODERATION' | 'DISCARDED', required — The state of the customer review when the API request was processed. See [our glossary entry](https://developers.etrusted.com/glossary.html#review) for more information on review states. - `type` 'SERVICE_REVIEW' | 'PRODUCT_REVIEW', required — The customer review type. A 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. - `verificationType` 'VERIFIED' | 'UNDEFINED' — 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. - `reply` CustomerReviewReplyDto — The reply to the customer review, written by the channel owner. - `createdAt` string, date-time, required — 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. - `updatedAt` string, date-time, required — 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. - `comment` string, required — The text message of the reply. - `sendNotification` boolean — Indicates whether the reviewer is notified about the reply by *eTrusted* or not. - `customer` object — This object holds information about the customer who wrote the review. - `firstName` string — The first name of the customer. - `lastName` string — The last name of the customer. - `fullName` string — The full name of the customer. - `email` string — An email address of the customer. - `mobile` string — A mobile phone number of the customer. - `transaction` object — The transaction associated with the customer review. - `reference` string, required — The transaction reference, e.g. `ORDER-12345`. - `date` string, date-time — 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. - `event` object — The event object that is associated with the customer review. - `id` string, required — The event UUID. - `type` string, required — The [event type](https://developers.etrusted.com/glossary.html#event-type). - `metadata` object — The `metadata` object is a collection of user-defined data added to the customer review. - `surveyData` object — The `surveyData` object holds custom response data from additional questions from *eTrusted* questionnaires. - `questionnaire` object, required — The questionnaire that was used to collect the customer review. - `id` string, required — The questionnaire UUID. - `locale` string, required — The questionnaire [locale](#tag/Locales). - `templateRef` string, required — A UUID as questionnaire template reference. - `hasAttachments` boolean — This indicates if the whether the customer review has attachments, such as images. - `additionalInformation` object — This object containts all of the additional information that is stored with the customer review. - `veto` object — The veto of this customer review. - `createdAt` string, date-time, required — 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. - `comment` string, required — The comment in the ticket that was created internally at *Trusted Shops* for this veto. - `reason` string, required — The reason for this veto. This string may only have the following values: * `UNTRUTHFUL` * `ABUSIVE` * `VIOLATES_THE_TERMS_OF_USE` - `ticketId` string, required — A reference to the ticket that was created internally at *Trusted Shops* for this veto. The ID is a sequence of six digits. - `attachments` object — Holds information about the attachments of this customer review. - `images` object[] — This is a list of image objects. Each image object represents a single image attached to this customer review. - `id` string, required — The attachment UUID. - `extensions` string, required — The extension of the image. - `urlOriginal` string, required — The url to the original image in original size. - `pathOriginal` string, required — The path to the original image in original size. - `pathThumbnail` string, required — The path to the thumbnail image. - `pathLarge` string, required — The path to the image in large size. - `originalReview` object — This object contains the original review, in case the consumer edited their review via our B2C world. - `rating` number — The star rating before the changes. The value ranges from `1.0` to `5.0`. - `title` string — A title headline for this customer review before any changes. - `comment` string — The review text for this customer review before any changes. - `reply` CustomerReviewReplyDto — The reply to the customer review, written by the channel owner. - `createdAt` string, date-time, required — 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. - `updatedAt` string, date-time, required — 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. - `comment` string, required — The text message of the reply. - `sendNotification` boolean — Indicates whether the reviewer is notified about the reply by *eTrusted* or not. - `product` CustomerReviewResponseProductDto — The product data retrieved with the customer review. - `id` string, required — The product UUID. - `sku` string, required — 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. It lets the shops track movement of inventory. The SKU must be unique and usually consists of about 8 characters. - `mpn` string — The Manufacturer Part Number is an identifier for a product by the manufacturer if applicable. In some cases it can serve as a substitute for the GTIN. - `gtin` string — The GTIN is a unique string that identifies the product globally. A GTIN can be an ISBN, an EAN, and much more. Refer to [gtin.info](https://www.gtin.info/). - `name` string, required — The product name contains information about a product that is associated with the customer review. E.g. `Specialbrand T-Shirt White M`. - `url` string, required — The link to the product detail page in your online shop or public catalog (e.g. http://www.specialbrandshop.com/article123-TS-WH-M/). - `imageUrl` string — The link to the product image of the product. eTrusted shows a picture of the product to the customer who wants to write a review. This makes it easier for customers to remember the purchase and recognize the product. - `brand` string — The brand of the product. A product can only have one brand. - `editedAt` string, date-time — 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. - `originalReview` OriginalReview — This is the initial unedited customer review. This object will not change when the review gets edited. - `rating` number — The original core review star rating. The value ranges from 1 to 5. - `comment` string — The original review comment. It is a string of up to 4000 characters. - `title` string — The original review title. - `reply` object — The original reply to the customer review, written by the channel owner. - `replyComment` string — The text message of the reply. - `replyCreatedAt` string, date-time — 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. - `replyUpdatedAt` string, date-time — 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. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not found --- [API](https://skmtc.net/etrusted/apis/accounts-api.md) · [All operations](https://skmtc.net/etrusted/apis/accounts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/etrusted/accounts-api/versions/649ef7dac98c/schema)