Contents

List All Customer Reviews for an App

Get a list of customer reviews for a specific app.

URL

GET https://api.appstoreconnect.apple.com/v1/apps/{id}/customerReviews

Path Parameters

NameTypeDescription
id Requiredstring

The opaque resource ID that uniquely identifies the apps resource that represents your app. Obtain the app resource ID from the List Apps response.

Query Parameters

NameTypeDescription
fields[customerReviewResponses] Optional[string]

Fields to return for the included related types.

fields[customerReviews] Optional[string]

Fields to return for the 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 Optionalinteger

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] Optionalboolean

A Boolean value that filters the reviews based on whether the review has a published response in the App Store. Use true to return the customer reviews that already have a published response in the App Store. Use false to return the customer reviews that don’t have a published response. Note that it’s possible that a review has a response that isn’t yet published.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CustomerReviewsResponse

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

429
Content-Type: application/json
ErrorResponse

Discussion

The example below limits the number of reviews returned in the response.

Example Request and Response

See Also

Getting customer reviews