Parsequerade / docs
Apps
GET/apps

Implemented · First release · Operator configuration and deployment required

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?bundleId=com.example.notes" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

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

Query parameters

NameTypeDescription
nameOptionalstringFilter by the resource’s name using Apple’s matching behavior. Multiple values are comma-separated.
bundleIdOptionalstringMatch a bundle identifier, such as com.example.notes. Multiple values are comma-separated.
skuOptionalstringFilter by the app’s SKU. Multiple values are comma-separated.
versionPlatformOptionalstringRequire related App Store versions to match these platforms. Multiple values are comma-separated.
ValuesIOS, MAC_OS, TV_OS, VISION_OS
versionStateOptionalstringRequire related App Store versions to match these current distribution states. Multiple values are comma-separated.
ValuesACCEPTED, DEVELOPER_REJECTED, IN_REVIEW, INVALID_BINARY, METADATA_REJECTED, PENDING_APPLE_RELEASE, PENDING_DEVELOPER_RELEASE, PREPARE_FOR_SUBMISSION, PROCESSING_FOR_DISTRIBUTION, READY_FOR_DISTRIBUTION, READY_FOR_REVIEW, REJECTED, REPLACED_WITH_NEW_VERSION, WAITING_FOR_EXPORT_COMPLIANCE, WAITING_FOR_REVIEW
reviewStateOptionalstringFilter by review state. Multiple values are comma-separated.
ValuesREADY_FOR_REVIEW, WAITING_FOR_REVIEW, IN_REVIEW, UNRESOLVED_ISSUES, CANCELING, COMPLETING, COMPLETE
reviewPlatformOptionalstringFilter by review platform. Multiple values are comma-separated.
ValuesIOS, MAC_OS, TV_OS, VISION_OS
versionIdOptionalstringFilter by version id. Multiple values are comma-separated.
idOptionalstringRestrict results to the specified resource IDs. Multiple values are comma-separated.
sortOptionalstringComma-separated sort keys. Prefix a key with - for descending order. Only the values below are supported. Multiple values are comma-separated.
Valuesname, -name, bundleId, -bundleId, sku, -sku
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuesaccessibilityUrl, name, bundleId, sku, primaryLocale, isOrEverWasMadeForKids, subscriptionStatusUrl, subscriptionStatusUrlVersion, subscriptionStatusUrlForSandbox, subscriptionStatusUrlVersionForSandbox, contentRightsDeclaration, streamlinedPurchasingEnabled
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": "1234567890",
      "name": "Example Notes",
      "bundleId": "com.example.notes",
      "sku": "example-ios",
      "primaryLocale": "en-US",
      "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT"
    }
  ],
  "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.
accessibilityUrlstring · uri | nullThe app’s accessibility-information website.
namestring | nullThe resource’s name. An app’s localized name is read from its app-info localization.
bundleIdstring | nullThe app’s bundle identifier, such as com.example.notes.
skustring | nullThe identifier you assigned to the app in App Store Connect.
primaryLocalestring | nullThe app’s primary locale. It does not cause automatic locale fallback.
isOrEverWasMadeForKidsboolean | nullWhether Apple records this app as having been made for kids.
subscriptionStatusUrlstring · uri | nullThe production server-notification URL configured for subscriptions.
subscriptionStatusUrlVersionstring | nullThe notification payload version configured for production.
ValuesV1, V2
subscriptionStatusUrlForSandboxstring · uri | nullThe sandbox server-notification URL configured for subscriptions.
subscriptionStatusUrlVersionForSandboxstring | nullThe notification payload version configured for the sandbox.
ValuesV1, V2
contentRightsDeclarationstring | nullWhether the app uses third-party content.
ValuesDOES_NOT_USE_THIRD_PARTY_CONTENT, USES_THIRD_PARTY_CONTENT
streamlinedPurchasingEnabledboolean | nullWhether the app has streamlined purchasing enabled.
appStoreIconIdOptional linkagestring | nullID of the related app store icon. Present only when Apple supplies linkage; related objects are not loaded automatically.
ciProductIdOptional linkagestring | nullID of the related ci product. Present only when Apple supplies linkage; related objects are not loaded automatically.
betaLicenseAgreementIdOptional linkagestring | nullID of the related beta license agreement. Present only when Apple supplies linkage; related objects are not loaded automatically.
betaAppReviewDetailIdOptional linkagestring | nullID of the related beta app review detail. Present only when Apple supplies linkage; related objects are not loaded automatically.
endUserLicenseAgreementIdOptional linkagestring | nullID of the related end user license agreement. Present only when Apple supplies linkage; related objects are not loaded automatically.
subscriptionGracePeriodIdOptional linkagestring | nullID of the related subscription grace period. Present only when Apple supplies linkage; related objects are not loaded automatically.
gameCenterDetailIdOptional linkagestring | nullID of the related game center detail. Present only when Apple supplies linkage; related objects are not loaded automatically.

Behavior

  • Use bundleId for an exact bundle-identifier match. Name and SKU filters use Apple’s supported matching behavior.
  • Versions, builds, and localizations have their own GET routes. This request does not silently load an app’s resource graph.

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/apps. 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
namequeryfilter[name]
bundleIdqueryfilter[bundleId]
skuqueryfilter[sku]
versionPlatformqueryfilter[appStoreVersions.platform]
versionStatequeryfilter[appStoreVersions.appVersionState]
reviewStatequeryfilter[reviewSubmissions.state]
reviewPlatformqueryfilter[reviewSubmissions.platform]
versionIdqueryfilter[appStoreVersions]
idqueryfilter[id]
sortquerysort
fieldsqueryfields[apps]
limitquerylimit
cursorqueryFacade-owned pagination

Reviewed 2026-10-14 · OpenAPI 4.5.1