> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetReviewRequest # Package: reviews # Namespace: ReviewRequestsV2 # Method link: https://dev.wix.com/docs/api-reference/crm/community/feedback-moderation/reviews/review-requests/get-review-request.md ## Permission Scopes: Read Review Requests: SCOPE.DC_REVIEWS.READ-REVIEW_REQUESTS ## Introduction Retrieves a review request. --- ## REST API ### Schema ``` Method: getReviewRequest Description: Retrieves a review request. URL: https://www.wixapis.com/reviews/v2/review-requests/{reviewRequestId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: reviewRequestId Method parameters: param name: reviewRequestId | type: none | required: true Return type: GetReviewRequestResponse - name: reviewRequest | type: ReviewRequest | description: Retrieved review request. - name: id | type: string | description: Review request GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the review request is updated. To prevent conflicting changes, the current revision must be passed when updating the review request. Ignored when creating a review request. - name: createdDate | type: string | description: Date and time the review request was created. - name: updatedDate | type: string | description: Date and time the review request was last updated. - name: sendDate | type: string | description: Date and time the review request was, or will be, sent. This field is only informational and does not trigger a send action. - name: namespace | type: string | description: Name of the Wix app whose catalog the items being reviewed belong to. Supported values: + Wix Stores: `stores` Currently, only Wix Stores is fully integrated with the Wix Reviews app. - name: order | type: Order | description: Order that a review is requested for. - name: id | type: string | description: Order GUID. - name: items | type: array | description: Items that a review is requested for. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. For example, `product.id` for items from the Stores Catalog API. - name: reviewId | type: string | description: GUID of the review created for this item by the review request recipient. - name: recipient | type: Recipient | description: Customer to send a review request to. - name: contactId | type: string | description: Recipient contact GUID. See the Contacts API for more information. - name: communicationChannel | type: CommunicationChannel | description: Communication channel for sending the review request. - enum: EMAIL - name: status | type: ReviewRequestStatus | description: Review request status. - enum: - UNKNOWN_REVIEW_REQUEST_STATUS: Unknown review request status. - SCHEDULED: Review request scheduled. - CANCELED: Review request canceled. - FAILED: Review request failed to send. - SENT: Review request sent. - name: automationActivationId | type: string | description: GUID of the automation action that triggered the review request to be created. This field is only used if a review request was created by the [automation included with Wix Reviews](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews#step-3-optional-customize-review-requests). Also see the Automations API for more information. - name: requestedBy | type: IdentificationData | description: GUID of the user or app that generated the review request. - ONE-OF: - name: wixUserId | type: string | description: Wix user GUID. - name: appId | type: string | description: Wix app GUID. - name: identityType | type: IdentityType | description: Identity type. - enum: WIX_USER, APP ``` ### Examples ### Get Review Request ```curl curl -X GET \ 'https://www.wixapis.com/reviews/v2/review-requests/15f470a4-a960-43bb-b1ed-886e1050efcd' \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.reviews.ReviewRequestsV2.getReviewRequest(reviewRequestId) Description: Retrieves a review request. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: reviewRequestId Method parameters: param name: reviewRequestId | type: string | description: GUID of the review request to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Review request GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the review request is updated. To prevent conflicting changes, the current revision must be passed when updating the review request. Ignored when creating a review request. - name: _createdDate | type: Date | description: Date and time the review request was created. - name: _updatedDate | type: Date | description: Date and time the review request was last updated. - name: sendDate | type: Date | description: Date and time the review request was, or will be, sent. This field is only informational and does not trigger a send action. - name: namespace | type: string | description: Name of the Wix app whose catalog the items being reviewed belong to. Supported values: + Wix Stores: `stores` Currently, only Wix Stores is fully integrated with the Wix Reviews app. - name: order | type: Order | description: Order that a review is requested for. - name: _id | type: string | description: Order GUID. - name: items | type: array | description: Items that a review is requested for. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. For example, `product.id` for items from the Stores Catalog API. - name: reviewId | type: string | description: GUID of the review created for this item by the review request recipient. - name: recipient | type: Recipient | description: Customer to send a review request to. - name: contactId | type: string | description: Recipient contact GUID. See the Contacts API for more information. - name: communicationChannel | type: CommunicationChannel | description: Communication channel for sending the review request. - enum: EMAIL - name: status | type: ReviewRequestStatus | description: Review request status. - enum: - UNKNOWN_REVIEW_REQUEST_STATUS: Unknown review request status. - SCHEDULED: Review request scheduled. - CANCELED: Review request canceled. - FAILED: Review request failed to send. - SENT: Review request sent. - name: automationActivationId | type: string | description: GUID of the automation action that triggered the review request to be created. This field is only used if a review request was created by the [automation included with Wix Reviews](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-wix-reviews#step-3-optional-customize-review-requests). Also see the Automations API for more information. - name: requestedBy | type: IdentificationData | description: GUID of the user or app that generated the review request. - ONE-OF: - name: wixUserId | type: string | description: Wix user GUID. - name: appId | type: string | description: Wix app GUID. - name: identityType | type: IdentityType | description: Identity type. - enum: WIX_USER, APP ``` ### Examples ### getReviewRequest ```javascript import { reviewRequests } from '@wix/reviews'; async function getReviewRequest(reviewRequestId) { const response = await reviewRequests.getReviewRequest(reviewRequestId); }; ``` ### getReviewRequest (with elevated permissions) ```javascript import { reviewRequests } from '@wix/reviews'; import { auth } from '@wix/essentials'; async function myGetReviewRequestMethod(reviewRequestId) { const elevatedGetReviewRequest = auth.elevate(reviewRequests.getReviewRequest); const response = await elevatedGetReviewRequest(reviewRequestId); } ``` ### getReviewRequest (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { reviewRequests } from '@wix/reviews'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { reviewRequests }, // Include the auth strategy and host as relevant }); async function getReviewRequest(reviewRequestId) { const response = await myWixClient.reviewRequests.getReviewRequest(reviewRequestId); }; ``` ---