List All Customer Reviews for an App Store Version
Get a list of customer reviews for a specific version of your app.
URL
GET https://api.appstoreconnect.apple.com/v1/appStoreVersions/{id}/customerReviewsPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[customerReviewResponses] Optional | [string] | Fields to return for included related types. |
fields[customerReviews] Optional | [string] | Fields to return for included related types. |
filter[rating] Optional | [string] | An array of numerical rating values by which to filter. For example, filtering for 1,2,5 shows only reviews with ratings of 1, 2, or 5. The minimum numeric rating value is 1, and the maximum is 5. |
include Optional | [string] | Relationship data to include in the response. |
limit Optional | integer | Number of resources to return. |
sort Optional | [string] | Attributes by which to sort. Supports one sort parameter at a time. |
filter[territory] Optional | [string] | A filter of territories to include in the response. |
exists[publishedResponse] Optional | boolean | A Boolean value that filters the reviews based on whether the review has a published response in the App Store. Use |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CustomerReviewsResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |