Read app information for an xcode cloud product
Get the app in App Store Connect that’s related to an Xcode Cloud product.
URL
GET https://api.appstoreconnect.apple.com/v1/ciProducts/{id}/appPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The opaque resource ID that uniquely identifies the Products resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[appInfos] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[appStoreVersions] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[apps] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[betaAppLocalizations] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[betaGroups] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[builds] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[gameCenterEnabledVersions] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[inAppPurchases] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
fields[preReleaseVersions] Optional | [string] | Additional fields to include for each Apps resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
limit[appInfos] Optional | integer | The number of included Apps resources to return if the app info relationship is included. |
limit[appStoreVersions] Optional | integer | The number of included Apps resources to return if the App Store versions relationship is included. |
limit[betaAppLocalizations] Optional | integer | The number of included Apps resources to return if the beta app localizations relationship is included. |
limit[betaGroups] Optional | integer | The number of included Apps resources to return if the beta groups relationship is included. |
limit[builds] Optional | integer | The number of included Apps resources to return if the builds relationship is included. |
limit[gameCenterEnabledVersions] Optional | integer | The number of included Apps resources to return if the Game Center enabled versions relationship is included. |
limit[inAppPurchases] Optional | integer | The number of included Apps resources to return if the in-app purchases relationship is included. |
limit[preReleaseVersions] Optional | integer | The number of included Apps resources to return if the pre-release versions relationship is included. |
limit[appClips] Optional | integer | |
fields[appClips] Optional | [string] | |
fields[reviewSubmissions] Optional | [string] | |
fields[appCustomProductPages] Optional | [string] | |
fields[appEvents] Optional | [string] | |
limit[appCustomProductPages] Optional | integer | |
limit[appEvents] Optional | integer | |
limit[reviewSubmissions] Optional | integer | |
fields[betaLicenseAgreements] Optional | [string] | |
fields[betaAppReviewDetails] Optional | [string] | |
fields[ciProducts] Optional | [string] | |
fields[endUserLicenseAgreements] Optional | [string] | |
fields[subscriptionGracePeriods] Optional | [string] | |
fields[subscriptionGroups] Optional | [string] | |
fields[promotedPurchases] Optional | [string] | |
limit[subscriptionGroups] Optional | integer | |
limit[inAppPurchasesV2] Optional | integer | |
limit[promotedPurchases] Optional | integer | |
fields[appStoreVersionExperiments] Optional | [string] | |
limit[appStoreVersionExperimentsV2] Optional | integer | |
fields[appEncryptionDeclarations] Optional | [string] | |
limit[appEncryptionDeclarations] Optional | integer | |
fields[gameCenterDetails] Optional | [string] | |
fields[androidToIosAppMappingDetails] Optional | [string] | |
fields[buildIcons] Optional | [string] | |
limit[androidToIosAppMappingDetails] Optional | integer |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppResponse | The request completed successfully. |
| 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 |
See Also
Getting Xcode Cloud Products
List all xcode cloud productsRead xcode cloud product informationList all additional repositories for an xcode cloud productList additional repository IDs for a CI productGet the app ID for a CI productList all xcode cloud builds for an xcode cloud productList build run IDs for a CI productList all primary git repositories for an xcode cloud productList primary repository IDs for a CI productList all workflows for an xcode cloud productList workflow IDs for a CI productRead the xcode cloud product for an app