Parsequerade / docs
App Store Versions
GET/apps/{appId}/versions/{versionId}/customer-reviews

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/apps/1234567890/versions/version_123/customer-reviews" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
appIdRequiredstringApple’s app ID. Returned by List apps.
versionIdRequiredstringAn explicit version ID belonging to this app. Select it from the version list.

Query parameters

NameTypeDescription
territoryOptionalstringRestrict results to the specified App Store territory IDs, such as USA. Multiple values are comma-separated.
ValuesABW, AFG, AGO, AIA, ALB, AND, ANT, ARE, ARG, ARM, ASM, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BWA, CAF, CAN, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PER, PHL, PLW, PNG, POL, PRI, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SEN, SGP, SHN, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, TCA, TCD, TGO, THA, TJK, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, XKS, YEM, ZAF, ZMB, ZWE
ratingOptionalstringFilter by rating. Multiple values are comma-separated.
reviewTerritoryOptionalstringFilter by review territory. Multiple values are comma-separated.
hasPublishedResponseOptionalbooleanFilter by has published response.
sortOptionalstringComma-separated sort keys. Prefix a key with - for descending order. Only the values below are supported. Multiple values are comma-separated.
Valuesrating, -rating, createdDate, -createdDate
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
Valuesrating, title, body, reviewerNickname, createdDate, territory
limitOptional · Default 50integerNumber of items per page, from 1 to 200.
cursorOptionalstringOpaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged.

Response

A page of flat objects, with an opaque continuation cursor.

200 · application/json
{
  "items": [
    {
      "id": "customer_review_123",
      "appId": "1234567890",
      "versionId": "version_123",
      "rating": 5,
      "title": "Helpful every day",
      "body": "Search makes it easy to find my notes."
    }
  ],
  "nextCursor": null
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
itemsobject[]The current page of plain resource objects. An empty collection returns [].
nextCursorstring | nullOpaque continuation token, or null when the collection is complete. Pass it back as cursor.

Each item

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
appIdstringThe app that owns this resource.
versionIdstringThe selected App Store version.
ratingintegerThe customer’s star rating.
titlestringThe customer review’s title.
bodystringThe customer review’s text.
reviewerNicknamestringThe customer’s public review nickname.
createdDatestring · date-timeWhen Apple created this resource, as an RFC 3339 timestamp.
territorystringThe territory value reported by Apple for this resource.
ValuesABW, AFG, AGO, AIA, ALB, AND, ANT, ARE, ARG, ARM, ASM, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BWA, CAF, CAN, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PER, PHL, PLW, PNG, POL, PRI, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SEN, SGP, SHN, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, TCA, TCD, TGO, THA, TJK, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, XKS, YEM, ZAF, ZMB, ZWE
responseIdOptional linkagestring | nullID of the related response. Present only when Apple supplies linkage; related objects are not loaded automatically.
reviewTerritoryIdOptional linkagestring | nullID of the related review territory. Present only when Apple supplies linkage; related objects are not loaded automatically.

Behavior

  • A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.

Pagination

Pass nextCursor back as cursor with the same filters and ordering. Stop when it is null. Each request returns one bounded page; the service never reports a capped or incomplete traversal as a complete collection.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/appStoreVersions/{id}/customerReviews. Read Apple’s original endpoint ↗

Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.

Facade parameterTypeDescription
territoryqueryfilter[territory]
ratingqueryfilter[rating]
reviewTerritoryqueryfilter[reviewTerritory]
hasPublishedResponsequeryexists[publishedResponse]
sortquerysort
fieldsqueryfields[customerReviews]
limitquerylimit
cursorqueryFacade-owned pagination

Reviewed 2026-10-14 · OpenAPI 4.5.1