App Store Connect API
App Store Connect API endpoints from Apple
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
App Store Connect API endpoints from Apple
Endpoints 252
AgeRatingDeclarations
- PATCHageRatingDeclarations-update_instance
/v1/ageRatingDeclarations/:id
AppCategories
- GETappCategories-get_collection
/v1/appCategories?filter[platforms]=IOS&exists[parent]=string&fields[appCategories]=parent&limit=0&include=parent&limit[subcategories]=0 - GETappCategories-get_instance
/v1/appCategories/:id?fields[appCategories]=parent&include=parent&limit[subcategories]=0 - GETappCategories-parent-get_to_one_related
/v1/appCategories/:id/parent?fields[appCategories]=parent - GETappCategories-subcategories-get_to_many_related
/v1/appCategories/:id/subcategories?fields[appCategories]=parent&limit=0
AppEncryptionDeclarations
- GETappEncryptionDeclarations-get_collection
/v1/appEncryptionDeclarations?filter[platform]=IOS&filter[app]=string&filter[builds]=string&fields[appEncryptionDeclarations]=app&limit=0&include=app&fields[apps]=appInfos - GETappEncryptionDeclarations-get_instance
/v1/appEncryptionDeclarations/:id?fields[appEncryptionDeclarations]=app&include=app&fields[apps]=appInfos - GETappEncryptionDeclarations-app-get_to_one_related
/v1/appEncryptionDeclarations/:id/app?fields[apps]=appInfos - POSTappEncryptionDeclarations-builds-create_to_many_relationship
/v1/appEncryptionDeclarations/:id/relationships/builds
AppInfoLocalizations
- POSTappInfoLocalizations-create_instance
/v1/appInfoLocalizations - GETappInfoLocalizations-get_instance
/v1/appInfoLocalizations/:id?fields[appInfoLocalizations]=appInfo&include=appInfo - DELETEappInfoLocalizations-delete_instance
/v1/appInfoLocalizations/:id - PATCHappInfoLocalizations-update_instance
/v1/appInfoLocalizations/:id
AppInfos
- GETappInfos-get_instance
/v1/appInfos/:id?fields[appInfos]=ageRatingDeclaration&include=ageRatingDeclaration&fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferences&fields[appCategories]=parent&fields[appInfoLocalizations]=appInfo&limit[appInfoLocalizations]=0 - PATCHappInfos-update_instance
/v1/appInfos/:id - GETappInfos-ageRatingDeclaration-get_to_one_related
/v1/appInfos/:id/ageRatingDeclaration?fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferences - GETappInfos-appInfoLocalizations-get_to_many_related
/v1/appInfos/:id/appInfoLocalizations?filter[locale]=string&fields[appInfos]=ageRatingDeclaration&fields[appInfoLocalizations]=appInfo&limit=0&include=appInfo - GETappInfos-primaryCategory-get_to_one_related
/v1/appInfos/:id/primaryCategory?fields[appCategories]=parent - GETappInfos-primarySubcategoryOne-get_to_one_related
/v1/appInfos/:id/primarySubcategoryOne?fields[appCategories]=parent - GETappInfos-primarySubcategoryTwo-get_to_one_related
/v1/appInfos/:id/primarySubcategoryTwo?fields[appCategories]=parent - GETappInfos-secondaryCategory-get_to_one_related
/v1/appInfos/:id/secondaryCategory?fields[appCategories]=parent - GETappInfos-secondarySubcategoryOne-get_to_one_related
/v1/appInfos/:id/secondarySubcategoryOne?fields[appCategories]=parent - GETappInfos-secondarySubcategoryTwo-get_to_one_related
/v1/appInfos/:id/secondarySubcategoryTwo?fields[appCategories]=parent
AppPreOrders
- POSTappPreOrders-create_instance
/v1/appPreOrders - GETappPreOrders-get_instance
/v1/appPreOrders/:id?fields[appPreOrders]=app&include=app - DELETEappPreOrders-delete_instance
/v1/appPreOrders/:id - PATCHappPreOrders-update_instance
/v1/appPreOrders/:id
AppPreviewSets
- POSTappPreviewSets-create_instance
/v1/appPreviewSets - GETappPreviewSets-get_instance
/v1/appPreviewSets/:id?fields[appPreviewSets]=appPreviews&include=appPreviews&fields[appPreviews]=appPreviewSet&limit[appPreviews]=0 - DELETEappPreviewSets-delete_instance
/v1/appPreviewSets/:id - GETappPreviewSets-appPreviews-get_to_many_related
/v1/appPreviewSets/:id/appPreviews?fields[appPreviews]=appPreviewSet&fields[appPreviewSets]=appPreviews&limit=0&include=appPreviewSet - GETappPreviewSets-appPreviews-get_to_many_relationship
/v1/appPreviewSets/:id/relationships/appPreviews?limit=0 - PATCHappPreviewSets-appPreviews-replace_to_many_relationship
/v1/appPreviewSets/:id/relationships/appPreviews
AppPreviews
- POSTappPreviews-create_instance
/v1/appPreviews - GETappPreviews-get_instance
/v1/appPreviews/:id?fields[appPreviews]=appPreviewSet&include=appPreviewSet - DELETEappPreviews-delete_instance
/v1/appPreviews/:id - PATCHappPreviews-update_instance
/v1/appPreviews/:id
AppPricePoints
- GETappPricePoints-get_collection
/v1/appPricePoints?filter[priceTier]=string&filter[territory]=string&fields[appPricePoints]=customerPrice&limit=0&include=priceTier&fields[territories]=currency - GETappPricePoints-get_instance
/v1/appPricePoints/:id?fields[appPricePoints]=customerPrice&include=priceTier&fields[territories]=currency - GETappPricePoints-territory-get_to_one_related
/v1/appPricePoints/:id/territory?fields[territories]=currency
AppPriceTiers
- GETappPriceTiers-get_collection
/v1/appPriceTiers?filter[id]=string&fields[appPriceTiers]=pricePoints&limit=0&include=pricePoints&fields[appPricePoints]=customerPrice&limit[pricePoints]=0 - GETappPriceTiers-get_instance
/v1/appPriceTiers/:id?fields[appPriceTiers]=pricePoints&include=pricePoints&fields[appPricePoints]=customerPrice&limit[pricePoints]=0 - GETappPriceTiers-pricePoints-get_to_many_related
/v1/appPriceTiers/:id/pricePoints?fields[appPricePoints]=customerPrice&limit=0
AppPrices
- GETappPrices-get_instance
/v1/appPrices/:id?fields[appPrices]=app&include=app
AppScreenshotSets
- POSTappScreenshotSets-create_instance
/v1/appScreenshotSets - GETappScreenshotSets-get_instance
/v1/appScreenshotSets/:id?fields[appScreenshotSets]=appScreenshots&include=appScreenshots&fields[appScreenshots]=appScreenshotSet&limit[appScreenshots]=0 - DELETEappScreenshotSets-delete_instance
/v1/appScreenshotSets/:id - GETappScreenshotSets-appScreenshots-get_to_many_related
/v1/appScreenshotSets/:id/appScreenshots?fields[appScreenshotSets]=appScreenshots&fields[appScreenshots]=appScreenshotSet&limit=0&include=appScreenshotSet - GETappScreenshotSets-appScreenshots-get_to_many_relationship
/v1/appScreenshotSets/:id/relationships/appScreenshots?limit=0 - PATCHappScreenshotSets-appScreenshots-replace_to_many_relationship
/v1/appScreenshotSets/:id/relationships/appScreenshots
AppScreenshots
- POSTappScreenshots-create_instance
/v1/appScreenshots - GETappScreenshots-get_instance
/v1/appScreenshots/:id?fields[appScreenshots]=appScreenshotSet&include=appScreenshotSet - DELETEappScreenshots-delete_instance
/v1/appScreenshots/:id - PATCHappScreenshots-update_instance
/v1/appScreenshots/:id
AppStoreReviewAttachments
- POSTappStoreReviewAttachments-create_instance
/v1/appStoreReviewAttachments - GETappStoreReviewAttachments-get_instance
/v1/appStoreReviewAttachments/:id?fields[appStoreReviewAttachments]=appStoreReviewDetail&include=appStoreReviewDetail - DELETEappStoreReviewAttachments-delete_instance
/v1/appStoreReviewAttachments/:id - PATCHappStoreReviewAttachments-update_instance
/v1/appStoreReviewAttachments/:id
AppStoreReviewDetails
- POSTappStoreReviewDetails-create_instance
/v1/appStoreReviewDetails - GETappStoreReviewDetails-get_instance
/v1/appStoreReviewDetails/:id?fields[appStoreReviewDetails]=appStoreReviewAttachments&include=appStoreReviewAttachments&fields[appStoreReviewAttachments]=appStoreReviewDetail&limit[appStoreReviewAttachments]=0 - PATCHappStoreReviewDetails-update_instance
/v1/appStoreReviewDetails/:id - GETappStoreReviewDetails-appStoreReviewAttachments-get_to_many_related
/v1/appStoreReviewDetails/:id/appStoreReviewAttachments?fields[appStoreReviewDetails]=appStoreReviewAttachments&fields[appStoreReviewAttachments]=appStoreReviewDetail&limit=0&include=appStoreReviewDetail
AppStoreVersionLocalizations
- POSTappStoreVersionLocalizations-create_instance
/v1/appStoreVersionLocalizations - GETappStoreVersionLocalizations-get_instance
/v1/appStoreVersionLocalizations/:id?fields[appStoreVersionLocalizations]=appPreviewSets&include=appPreviewSets&fields[appScreenshotSets]=appScreenshots&fields[appPreviewSets]=appPreviews&limit[appPreviewSets]=0&limit[appScreenshotSets]=0 - DELETEappStoreVersionLocalizations-delete_instance
/v1/appStoreVersionLocalizations/:id - PATCHappStoreVersionLocalizations-update_instance
/v1/appStoreVersionLocalizations/:id - GETappStoreVersionLocalizations-appPreviewSets-get_to_many_related
/v1/appStoreVersionLocalizations/:id/appPreviewSets?filter[previewType]=IPHONE_65&fields[appStoreVersionLocalizations]=appPreviewSets&fields[appPreviews]=appPreviewSet&fields[appPreviewSets]=appPreviews&limit=0&include=appPreviews - GETappStoreVersionLocalizations-appScreenshotSets-get_to_many_related
/v1/appStoreVersionLocalizations/:id/appScreenshotSets?filter[screenshotDisplayType]=APP_IPHONE_65&fields[appStoreVersionLocalizations]=appPreviewSets&fields[appScreenshotSets]=appScreenshots&fields[appScreenshots]=appScreenshotSet&limit=0&include=appScreenshots
AppStoreVersionPhasedReleases
- POSTappStoreVersionPhasedReleases-create_instance
/v1/appStoreVersionPhasedReleases - DELETEappStoreVersionPhasedReleases-delete_instance
/v1/appStoreVersionPhasedReleases/:id - PATCHappStoreVersionPhasedReleases-update_instance
/v1/appStoreVersionPhasedReleases/:id
AppStoreVersionSubmissions
- POSTappStoreVersionSubmissions-create_instance
/v1/appStoreVersionSubmissions - DELETEappStoreVersionSubmissions-delete_instance
/v1/appStoreVersionSubmissions/:id
AppStoreVersions
- POSTappStoreVersions-create_instance
/v1/appStoreVersions - GETappStoreVersions-get_instance
/v1/appStoreVersions/:id?fields[appStoreVersions]=ageRatingDeclaration&include=ageRatingDeclaration&fields[appStoreVersionLocalizations]=appPreviewSets&fields[idfaDeclarations]=appStoreVersion&fields[routingAppCoverages]=appStoreVersion&fields[appStoreVersionPhasedReleases]=appStoreVersion&fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferences&fields[appStoreReviewDetails]=appStoreReviewAttachments&fields[builds]=app&fields[appStoreVersionSubmissions]=appStoreVersion&limit[appStoreVersionLocalizations]=0 - DELETEappStoreVersions-delete_instance
/v1/appStoreVersions/:id - PATCHappStoreVersions-update_instance
/v1/appStoreVersions/:id - GETappStoreVersions-ageRatingDeclaration-get_to_one_related
/v1/appStoreVersions/:id/ageRatingDeclaration?fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferencesDeprecated. - GETappStoreVersions-appStoreReviewDetail-get_to_one_related
/v1/appStoreVersions/:id/appStoreReviewDetail?fields[appStoreReviewDetails]=appStoreReviewAttachments&fields[appStoreVersions]=ageRatingDeclaration&fields[appStoreReviewAttachments]=appStoreReviewDetail&include=appStoreReviewAttachments - GETappStoreVersions-appStoreVersionLocalizations-get_to_many_related
/v1/appStoreVersions/:id/appStoreVersionLocalizations?fields[appStoreVersionLocalizations]=appPreviewSets&limit=0 - GETappStoreVersions-appStoreVersionPhasedRelease-get_to_one_related
/v1/appStoreVersions/:id/appStoreVersionPhasedRelease?fields[appStoreVersionPhasedReleases]=appStoreVersion - GETappStoreVersions-appStoreVersionSubmission-get_to_one_related
/v1/appStoreVersions/:id/appStoreVersionSubmission?fields[appStoreVersions]=ageRatingDeclaration&fields[appStoreVersionSubmissions]=appStoreVersion&include=appStoreVersion - GETappStoreVersions-build-get_to_one_related
/v1/appStoreVersions/:id/build?fields[builds]=app - GETappStoreVersions-idfaDeclaration-get_to_one_related
/v1/appStoreVersions/:id/idfaDeclaration?fields[idfaDeclarations]=appStoreVersion - GETappStoreVersions-build-get_to_one_relationship
/v1/appStoreVersions/:id/relationships/build - PATCHappStoreVersions-build-update_to_one_relationship
/v1/appStoreVersions/:id/relationships/build - GETappStoreVersions-routingAppCoverage-get_to_one_related
/v1/appStoreVersions/:id/routingAppCoverage?fields[routingAppCoverages]=appStoreVersion
Apps
- GETapps-get_collection
/v1/apps?filter[appStoreVersions.appStoreState]=DEVELOPER_REMOVED_FROM_SALE&filter[appStoreVersions.platform]=IOS&filter[bundleId]=string&filter[name]=string&filter[sku]=string&filter[appStoreVersions]=string&filter[id]=string&exists[gameCenterEnabledVersions]=string&sort=bundleId&fields[apps]=appInfos&limit=0&include=appInfos&fields[betaGroups]=app&fields[perfPowerMetrics]=deviceType&fields[appInfos]=ageRatingDeclaration&fields[appPreOrders]=app&fields[preReleaseVersions]=app&fields[appPrices]=app&fields[inAppPurchases]=apps&fields[betaAppReviewDetails]=app&fields[territories]=currency&fields[gameCenterEnabledVersions]=app&fields[appStoreVersions]=ageRatingDeclaration&fields[builds]=app&fields[betaAppLocalizations]=app&fields[betaLicenseAgreements]=agreementText&fields[endUserLicenseAgreements]=agreementText&limit[appInfos]=0&limit[appStoreVersions]=0&limit[availableTerritories]=0&limit[betaAppLocalizations]=0&limit[betaGroups]=0&limit[builds]=0&limit[gameCenterEnabledVersions]=0&limit[inAppPurchases]=0&limit[preReleaseVersions]=0&limit[prices]=0 - GETapps-get_instance
/v1/apps/:id?fields[apps]=appInfos&include=appInfos&fields[betaGroups]=app&fields[perfPowerMetrics]=deviceType&fields[appInfos]=ageRatingDeclaration&fields[appPreOrders]=app&fields[preReleaseVersions]=app&fields[appPrices]=app&fields[inAppPurchases]=apps&fields[betaAppReviewDetails]=app&fields[territories]=currency&fields[gameCenterEnabledVersions]=app&fields[appStoreVersions]=ageRatingDeclaration&fields[builds]=app&fields[betaAppLocalizations]=app&fields[betaLicenseAgreements]=agreementText&fields[endUserLicenseAgreements]=agreementText&limit[appInfos]=0&limit[appStoreVersions]=0&limit[availableTerritories]=0&limit[betaAppLocalizations]=0&limit[betaGroups]=0&limit[builds]=0&limit[gameCenterEnabledVersions]=0&limit[inAppPurchases]=0&limit[preReleaseVersions]=0&limit[prices]=0 - PATCHapps-update_instance
/v1/apps/:id - GETapps-appInfos-get_to_many_related
/v1/apps/:id/appInfos?fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferences&fields[appInfos]=ageRatingDeclaration&fields[appCategories]=parent&fields[appInfoLocalizations]=appInfo&fields[apps]=appInfos&limit=0&include=app - GETapps-appStoreVersions-get_to_many_related
/v1/apps/:id/appStoreVersions?filter[appStoreState]=DEVELOPER_REMOVED_FROM_SALE&filter[platform]=IOS&filter[versionString]=string&filter[id]=string&fields[idfaDeclarations]=appStoreVersion&fields[appStoreVersionLocalizations]=appPreviewSets&fields[routingAppCoverages]=appStoreVersion&fields[appStoreVersionPhasedReleases]=appStoreVersion&fields[ageRatingDeclarations]=alcoholTobaccoOrDrugUseOrReferences&fields[appStoreReviewDetails]=appStoreReviewAttachments&fields[appStoreVersions]=ageRatingDeclaration&fields[builds]=app&fields[appStoreVersionSubmissions]=appStoreVersion&fields[apps]=appInfos&limit=0&include=ageRatingDeclaration - GETapps-availableTerritories-get_to_many_related
/v1/apps/:id/availableTerritories?fields[territories]=currency&limit=0 - GETapps-betaAppLocalizations-get_to_many_related
/v1/apps/:id/betaAppLocalizations?fields[betaAppLocalizations]=app&limit=0 - GETapps-betaAppReviewDetail-get_to_one_related
/v1/apps/:id/betaAppReviewDetail?fields[betaAppReviewDetails]=app - GETapps-betaGroups-get_to_many_related
/v1/apps/:id/betaGroups?fields[betaGroups]=app&limit=0 - GETapps-betaLicenseAgreement-get_to_one_related
/v1/apps/:id/betaLicenseAgreement?fields[betaLicenseAgreements]=agreementText - GETapps-builds-get_to_many_related
/v1/apps/:id/builds?fields[builds]=app&limit=0 - GETapps-endUserLicenseAgreement-get_to_one_related
/v1/apps/:id/endUserLicenseAgreement?fields[endUserLicenseAgreements]=agreementText - GETapps-gameCenterEnabledVersions-get_to_many_related
/v1/apps/:id/gameCenterEnabledVersions?filter[platform]=IOS&filter[versionString]=string&filter[id]=string&sort=versionString&fields[gameCenterEnabledVersions]=app&fields[apps]=appInfos&limit=0&include=app - GETapps-inAppPurchases-get_to_many_related
/v1/apps/:id/inAppPurchases?filter[inAppPurchaseType]=AUTOMATICALLY_RENEWABLE_SUBSCRIPTION&filter[canBeSubmitted]=string&sort=inAppPurchaseType&fields[inAppPurchases]=apps&fields[apps]=appInfos&limit=0&include=apps - GETapps-perfPowerMetrics-get_to_many_related
/v1/apps/:id/perfPowerMetrics?filter[deviceType]=string&filter[metricType]=DISK&filter[platform]=IOS - GETapps-preOrder-get_to_one_related
/v1/apps/:id/preOrder?fields[appPreOrders]=app - GETapps-preReleaseVersions-get_to_many_related
/v1/apps/:id/preReleaseVersions?fields[preReleaseVersions]=app&limit=0 - GETapps-prices-get_to_many_related
/v1/apps/:id/prices?fields[appPrices]=app&fields[appPriceTiers]=pricePoints&fields[apps]=appInfos&limit=0&include=app - DELETEapps-betaTesters-delete_to_many_relationship
/v1/apps/:id/relationships/betaTesters
BetaAppLocalizations
- GETbetaAppLocalizations-get_collection
/v1/betaAppLocalizations?filter[locale]=string&filter[app]=string&fields[betaAppLocalizations]=app&limit=0&include=app&fields[apps]=appInfos - POSTbetaAppLocalizations-create_instance
/v1/betaAppLocalizations - GETbetaAppLocalizations-get_instance
/v1/betaAppLocalizations/:id?fields[betaAppLocalizations]=app&include=app&fields[apps]=appInfos - DELETEbetaAppLocalizations-delete_instance
/v1/betaAppLocalizations/:id - PATCHbetaAppLocalizations-update_instance
/v1/betaAppLocalizations/:id - GETbetaAppLocalizations-app-get_to_one_related
/v1/betaAppLocalizations/:id/app?fields[apps]=appInfos
BetaAppReviewDetails
- GETbetaAppReviewDetails-get_collection
/v1/betaAppReviewDetails?filter[app]=string&fields[betaAppReviewDetails]=app&limit=0&include=app&fields[apps]=appInfos - GETbetaAppReviewDetails-get_instance
/v1/betaAppReviewDetails/:id?fields[betaAppReviewDetails]=app&include=app&fields[apps]=appInfos - PATCHbetaAppReviewDetails-update_instance
/v1/betaAppReviewDetails/:id - GETbetaAppReviewDetails-app-get_to_one_related
/v1/betaAppReviewDetails/:id/app?fields[apps]=appInfos
BetaAppReviewSubmissions
- GETbetaAppReviewSubmissions-get_collection
/v1/betaAppReviewSubmissions?filter[betaReviewState]=WAITING_FOR_REVIEW&filter[build]=string&fields[betaAppReviewSubmissions]=betaReviewState&limit=0&include=build&fields[builds]=app - POSTbetaAppReviewSubmissions-create_instance
/v1/betaAppReviewSubmissions - GETbetaAppReviewSubmissions-get_instance
/v1/betaAppReviewSubmissions/:id?fields[betaAppReviewSubmissions]=betaReviewState&include=build&fields[builds]=app - GETbetaAppReviewSubmissions-build-get_to_one_related
/v1/betaAppReviewSubmissions/:id/build?fields[builds]=app
BetaBuildLocalizations
- GETbetaBuildLocalizations-get_collection
/v1/betaBuildLocalizations?filter[locale]=string&filter[build]=string&fields[betaBuildLocalizations]=build&limit=0&include=build&fields[builds]=app - POSTbetaBuildLocalizations-create_instance
/v1/betaBuildLocalizations - GETbetaBuildLocalizations-get_instance
/v1/betaBuildLocalizations/:id?fields[betaBuildLocalizations]=build&include=build&fields[builds]=app - DELETEbetaBuildLocalizations-delete_instance
/v1/betaBuildLocalizations/:id - PATCHbetaBuildLocalizations-update_instance
/v1/betaBuildLocalizations/:id - GETbetaBuildLocalizations-build-get_to_one_related
/v1/betaBuildLocalizations/:id/build?fields[builds]=app
BetaGroups
- GETbetaGroups-get_collection
/v1/betaGroups?filter[isInternalGroup]=string&filter[name]=string&filter[publicLink]=string&filter[publicLinkEnabled]=string&filter[publicLinkLimitEnabled]=string&filter[app]=string&filter[builds]=string&filter[id]=string&sort=createdDate&fields[betaGroups]=app&limit=0&include=app&fields[builds]=app&fields[betaTesters]=apps&fields[apps]=appInfos&limit[betaTesters]=0&limit[builds]=0 - POSTbetaGroups-create_instance
/v1/betaGroups - GETbetaGroups-get_instance
/v1/betaGroups/:id?fields[betaGroups]=app&include=app&fields[builds]=app&fields[betaTesters]=apps&fields[apps]=appInfos&limit[betaTesters]=0&limit[builds]=0 - DELETEbetaGroups-delete_instance
/v1/betaGroups/:id - PATCHbetaGroups-update_instance
/v1/betaGroups/:id - GETbetaGroups-app-get_to_one_related
/v1/betaGroups/:id/app?fields[apps]=appInfos - GETbetaGroups-betaTesters-get_to_many_related
/v1/betaGroups/:id/betaTesters?fields[betaTesters]=apps&limit=0 - GETbetaGroups-builds-get_to_many_related
/v1/betaGroups/:id/builds?fields[builds]=app&limit=0 - GETbetaGroups-betaTesters-get_to_many_relationship
/v1/betaGroups/:id/relationships/betaTesters?limit=0 - POSTbetaGroups-betaTesters-create_to_many_relationship
/v1/betaGroups/:id/relationships/betaTesters - DELETEbetaGroups-betaTesters-delete_to_many_relationship
/v1/betaGroups/:id/relationships/betaTesters - GETbetaGroups-builds-get_to_many_relationship
/v1/betaGroups/:id/relationships/builds?limit=0 - POSTbetaGroups-builds-create_to_many_relationship
/v1/betaGroups/:id/relationships/builds - DELETEbetaGroups-builds-delete_to_many_relationship
/v1/betaGroups/:id/relationships/builds
BetaLicenseAgreements
- GETbetaLicenseAgreements-get_collection
/v1/betaLicenseAgreements?filter[app]=string&fields[betaLicenseAgreements]=agreementText&limit=0&include=app&fields[apps]=appInfos - GETbetaLicenseAgreements-get_instance
/v1/betaLicenseAgreements/:id?fields[betaLicenseAgreements]=agreementText&include=app&fields[apps]=appInfos - PATCHbetaLicenseAgreements-update_instance
/v1/betaLicenseAgreements/:id - GETbetaLicenseAgreements-app-get_to_one_related
/v1/betaLicenseAgreements/:id/app?fields[apps]=appInfos
BetaTesterInvitations
- POSTbetaTesterInvitations-create_instance
/v1/betaTesterInvitations
BetaTesters
- GETbetaTesters-get_collection
/v1/betaTesters?filter[email]=string&filter[firstName]=string&filter[inviteType]=EMAIL&filter[lastName]=string&filter[apps]=string&filter[betaGroups]=string&filter[builds]=string&sort=email&fields[betaTesters]=apps&limit=0&include=apps&fields[betaGroups]=app&fields[builds]=app&fields[apps]=appInfos&limit[apps]=0&limit[betaGroups]=0&limit[builds]=0 - POSTbetaTesters-create_instance
/v1/betaTesters - GETbetaTesters-get_instance
/v1/betaTesters/:id?fields[betaTesters]=apps&include=apps&fields[betaGroups]=app&fields[builds]=app&fields[apps]=appInfos&limit[apps]=0&limit[betaGroups]=0&limit[builds]=0 - DELETEbetaTesters-delete_instance
/v1/betaTesters/:id - GETbetaTesters-apps-get_to_many_related
/v1/betaTesters/:id/apps?fields[apps]=appInfos&limit=0 - GETbetaTesters-betaGroups-get_to_many_related
/v1/betaTesters/:id/betaGroups?fields[betaGroups]=app&limit=0 - GETbetaTesters-builds-get_to_many_related
/v1/betaTesters/:id/builds?fields[builds]=app&limit=0 - GETbetaTesters-apps-get_to_many_relationship
/v1/betaTesters/:id/relationships/apps?limit=0 - DELETEbetaTesters-apps-delete_to_many_relationship
/v1/betaTesters/:id/relationships/apps - GETbetaTesters-betaGroups-get_to_many_relationship
/v1/betaTesters/:id/relationships/betaGroups?limit=0 - POSTbetaTesters-betaGroups-create_to_many_relationship
/v1/betaTesters/:id/relationships/betaGroups - DELETEbetaTesters-betaGroups-delete_to_many_relationship
/v1/betaTesters/:id/relationships/betaGroups - GETbetaTesters-builds-get_to_many_relationship
/v1/betaTesters/:id/relationships/builds?limit=0 - POSTbetaTesters-builds-create_to_many_relationship
/v1/betaTesters/:id/relationships/builds - DELETEbetaTesters-builds-delete_to_many_relationship
/v1/betaTesters/:id/relationships/builds
BuildBetaDetails
- GETbuildBetaDetails-get_collection
/v1/buildBetaDetails?filter[build]=string&filter[id]=string&fields[buildBetaDetails]=autoNotifyEnabled&limit=0&include=build&fields[builds]=app - GETbuildBetaDetails-get_instance
/v1/buildBetaDetails/:id?fields[buildBetaDetails]=autoNotifyEnabled&include=build&fields[builds]=app - PATCHbuildBetaDetails-update_instance
/v1/buildBetaDetails/:id - GETbuildBetaDetails-build-get_to_one_related
/v1/buildBetaDetails/:id/build?fields[builds]=app
BuildBetaNotifications
- POSTbuildBetaNotifications-create_instance
/v1/buildBetaNotifications
Builds
- GETbuilds-get_collection
/v1/builds?filter[betaAppReviewSubmission.betaReviewState]=WAITING_FOR_REVIEW&filter[expired]=string&filter[preReleaseVersion.platform]=IOS&filter[preReleaseVersion.version]=string&filter[processingState]=PROCESSING&filter[usesNonExemptEncryption]=string&filter[version]=string&filter[app]=string&filter[appStoreVersion]=string&filter[betaGroups]=string&filter[preReleaseVersion]=string&filter[id]=string&sort=preReleaseVersion&fields[builds]=app&limit=0&include=app&fields[appEncryptionDeclarations]=app&fields[betaAppReviewSubmissions]=betaReviewState&fields[buildBetaDetails]=autoNotifyEnabled&fields[buildIcons]=iconAsset&fields[perfPowerMetrics]=deviceType&fields[preReleaseVersions]=app&fields[appStoreVersions]=ageRatingDeclaration&fields[diagnosticSignatures]=diagnosticType&fields[betaTesters]=apps&fields[betaBuildLocalizations]=build&fields[apps]=appInfos&limit[betaBuildLocalizations]=0&limit[icons]=0&limit[individualTesters]=0 - GETbuilds-get_instance
/v1/builds/:id?fields[builds]=app&include=app&fields[appEncryptionDeclarations]=app&fields[betaAppReviewSubmissions]=betaReviewState&fields[buildBetaDetails]=autoNotifyEnabled&fields[buildIcons]=iconAsset&fields[perfPowerMetrics]=deviceType&fields[preReleaseVersions]=app&fields[appStoreVersions]=ageRatingDeclaration&fields[diagnosticSignatures]=diagnosticType&fields[betaTesters]=apps&fields[betaBuildLocalizations]=build&fields[apps]=appInfos&limit[betaBuildLocalizations]=0&limit[icons]=0&limit[individualTesters]=0 - PATCHbuilds-update_instance
/v1/builds/:id - GETbuilds-app-get_to_one_related
/v1/builds/:id/app?fields[apps]=appInfos - GETbuilds-appEncryptionDeclaration-get_to_one_related
/v1/builds/:id/appEncryptionDeclaration?fields[appEncryptionDeclarations]=app - GETbuilds-appStoreVersion-get_to_one_related
/v1/builds/:id/appStoreVersion?fields[appStoreVersions]=ageRatingDeclaration - GETbuilds-betaAppReviewSubmission-get_to_one_related
/v1/builds/:id/betaAppReviewSubmission?fields[betaAppReviewSubmissions]=betaReviewState - GETbuilds-betaBuildLocalizations-get_to_many_related
/v1/builds/:id/betaBuildLocalizations?fields[betaBuildLocalizations]=build&limit=0 - GETbuilds-buildBetaDetail-get_to_one_related
/v1/builds/:id/buildBetaDetail?fields[buildBetaDetails]=autoNotifyEnabled - GETbuilds-diagnosticSignatures-get_to_many_related
/v1/builds/:id/diagnosticSignatures?filter[diagnosticType]=DISK_WRITES&fields[diagnosticSignatures]=diagnosticType&limit=0 - GETbuilds-icons-get_to_many_related
/v1/builds/:id/icons?fields[buildIcons]=iconAsset&limit=0 - GETbuilds-individualTesters-get_to_many_related
/v1/builds/:id/individualTesters?fields[betaTesters]=apps&limit=0 - GETbuilds-perfPowerMetrics-get_to_many_related
/v1/builds/:id/perfPowerMetrics?filter[deviceType]=string&filter[metricType]=DISK&filter[platform]=IOS - GETbuilds-preReleaseVersion-get_to_one_related
/v1/builds/:id/preReleaseVersion?fields[preReleaseVersions]=app - GETbuilds-appEncryptionDeclaration-get_to_one_relationship
/v1/builds/:id/relationships/appEncryptionDeclaration - PATCHbuilds-appEncryptionDeclaration-update_to_one_relationship
/v1/builds/:id/relationships/appEncryptionDeclaration - POSTbuilds-betaGroups-create_to_many_relationship
/v1/builds/:id/relationships/betaGroups - DELETEbuilds-betaGroups-delete_to_many_relationship
/v1/builds/:id/relationships/betaGroups - GETbuilds-individualTesters-get_to_many_relationship
/v1/builds/:id/relationships/individualTesters?limit=0 - POSTbuilds-individualTesters-create_to_many_relationship
/v1/builds/:id/relationships/individualTesters - DELETEbuilds-individualTesters-delete_to_many_relationship
/v1/builds/:id/relationships/individualTesters
BundleIdCapabilities
- POSTbundleIdCapabilities-create_instance
/v1/bundleIdCapabilities - DELETEbundleIdCapabilities-delete_instance
/v1/bundleIdCapabilities/:id - PATCHbundleIdCapabilities-update_instance
/v1/bundleIdCapabilities/:id
BundleIds
- GETbundleIds-get_collection
/v1/bundleIds?filter[identifier]=string&filter[name]=string&filter[platform]=IOS&filter[seedId]=string&filter[id]=string&sort=id&fields[bundleIds]=app&limit=0&include=app&fields[bundleIdCapabilities]=bundleId&fields[profiles]=bundleId&fields[apps]=appInfos&limit[bundleIdCapabilities]=0&limit[profiles]=0 - POSTbundleIds-create_instance
/v1/bundleIds - GETbundleIds-get_instance
/v1/bundleIds/:id?fields[bundleIds]=app&include=app&fields[bundleIdCapabilities]=bundleId&fields[profiles]=bundleId&fields[apps]=appInfos&limit[bundleIdCapabilities]=0&limit[profiles]=0 - DELETEbundleIds-delete_instance
/v1/bundleIds/:id - PATCHbundleIds-update_instance
/v1/bundleIds/:id - GETbundleIds-app-get_to_one_related
/v1/bundleIds/:id/app?fields[apps]=appInfos - GETbundleIds-bundleIdCapabilities-get_to_many_related
/v1/bundleIds/:id/bundleIdCapabilities?fields[bundleIdCapabilities]=bundleId&limit=0 - GETbundleIds-profiles-get_to_many_related
/v1/bundleIds/:id/profiles?fields[profiles]=bundleId&limit=0
Certificates
- GETcertificates-get_collection
/v1/certificates?filter[certificateType]=IOS_DEVELOPMENT&filter[displayName]=string&filter[serialNumber]=string&filter[id]=string&sort=certificateType&fields[certificates]=certificateContent&limit=0 - POSTcertificates-create_instance
/v1/certificates - GETcertificates-get_instance
/v1/certificates/:id?fields[certificates]=certificateContent - DELETEcertificates-delete_instance
/v1/certificates/:id
Devices
- GETdevices-get_collection
/v1/devices?filter[name]=string&filter[platform]=IOS&filter[status]=ENABLED&filter[udid]=string&filter[id]=string&sort=id&fields[devices]=addedDate&limit=0 - POSTdevices-create_instance
/v1/devices - GETdevices-get_instance
/v1/devices/:id?fields[devices]=addedDate - PATCHdevices-update_instance
/v1/devices/:id
DiagnosticSignatures
- GETdiagnosticSignatures-logs-get_to_many_related
/v1/diagnosticSignatures/:id/logs?limit=0
EndUserLicenseAgreements
- POSTendUserLicenseAgreements-create_instance
/v1/endUserLicenseAgreements - GETendUserLicenseAgreements-get_instance
/v1/endUserLicenseAgreements/:id?fields[endUserLicenseAgreements]=agreementText&include=app&fields[territories]=currency&limit[territories]=0 - DELETEendUserLicenseAgreements-delete_instance
/v1/endUserLicenseAgreements/:id - PATCHendUserLicenseAgreements-update_instance
/v1/endUserLicenseAgreements/:id - GETendUserLicenseAgreements-territories-get_to_many_related
/v1/endUserLicenseAgreements/:id/territories?fields[territories]=currency&limit=0
FinanceReports
- GETfinanceReports-get_collection
/v1/financeReports?filter[regionCode]=string&filter[reportDate]=string&filter[reportType]=FINANCIAL&filter[vendorNumber]=string
GameCenterEnabledVersions
- GETgameCenterEnabledVersions-compatibleVersions-get_to_many_related
/v1/gameCenterEnabledVersions/:id/compatibleVersions?filter[platform]=IOS&filter[versionString]=string&filter[app]=string&filter[id]=string&sort=versionString&fields[gameCenterEnabledVersions]=app&fields[apps]=appInfos&limit=0&include=app - GETgameCenterEnabledVersions-compatibleVersions-get_to_many_relationship
/v1/gameCenterEnabledVersions/:id/relationships/compatibleVersions?limit=0 - POSTgameCenterEnabledVersions-compatibleVersions-create_to_many_relationship
/v1/gameCenterEnabledVersions/:id/relationships/compatibleVersions - DELETEgameCenterEnabledVersions-compatibleVersions-delete_to_many_relationship
/v1/gameCenterEnabledVersions/:id/relationships/compatibleVersions - PATCHgameCenterEnabledVersions-compatibleVersions-replace_to_many_relationship
/v1/gameCenterEnabledVersions/:id/relationships/compatibleVersions
IdfaDeclarations
- POSTidfaDeclarations-create_instance
/v1/idfaDeclarations - DELETEidfaDeclarations-delete_instance
/v1/idfaDeclarations/:id - PATCHidfaDeclarations-update_instance
/v1/idfaDeclarations/:id
InAppPurchases
- GETinAppPurchases-get_instance
/v1/inAppPurchases/:id?fields[inAppPurchases]=apps&include=apps&limit[apps]=0
PreReleaseVersions
- GETpreReleaseVersions-get_collection
/v1/preReleaseVersions?filter[builds.expired]=string&filter[builds.processingState]=PROCESSING&filter[platform]=IOS&filter[version]=string&filter[app]=string&filter[builds]=string&sort=version&fields[preReleaseVersions]=app&limit=0&include=app&fields[builds]=app&fields[apps]=appInfos&limit[builds]=0 - GETpreReleaseVersions-get_instance
/v1/preReleaseVersions/:id?fields[preReleaseVersions]=app&include=app&fields[builds]=app&fields[apps]=appInfos&limit[builds]=0 - GETpreReleaseVersions-app-get_to_one_related
/v1/preReleaseVersions/:id/app?fields[apps]=appInfos - GETpreReleaseVersions-builds-get_to_many_related
/v1/preReleaseVersions/:id/builds?fields[builds]=app&limit=0
Profiles
- GETprofiles-get_collection
/v1/profiles?filter[name]=string&filter[profileState]=ACTIVE&filter[profileType]=IOS_APP_DEVELOPMENT&filter[id]=string&sort=id&fields[profiles]=bundleId&limit=0&include=bundleId&fields[certificates]=certificateContent&fields[devices]=addedDate&fields[bundleIds]=app&limit[certificates]=0&limit[devices]=0 - POSTprofiles-create_instance
/v1/profiles - GETprofiles-get_instance
/v1/profiles/:id?fields[profiles]=bundleId&include=bundleId&fields[certificates]=certificateContent&fields[devices]=addedDate&fields[bundleIds]=app&limit[certificates]=0&limit[devices]=0 - DELETEprofiles-delete_instance
/v1/profiles/:id - GETprofiles-bundleId-get_to_one_related
/v1/profiles/:id/bundleId?fields[bundleIds]=app - GETprofiles-certificates-get_to_many_related
/v1/profiles/:id/certificates?fields[certificates]=certificateContent&limit=0 - GETprofiles-devices-get_to_many_related
/v1/profiles/:id/devices?fields[devices]=addedDate&limit=0
RoutingAppCoverages
- POSTroutingAppCoverages-create_instance
/v1/routingAppCoverages - GETroutingAppCoverages-get_instance
/v1/routingAppCoverages/:id?fields[routingAppCoverages]=appStoreVersion&include=appStoreVersion - DELETEroutingAppCoverages-delete_instance
/v1/routingAppCoverages/:id - PATCHroutingAppCoverages-update_instance
/v1/routingAppCoverages/:id
SalesReports
- GETsalesReports-get_collection
/v1/salesReports?filter[frequency]=DAILY&filter[reportDate]=string&filter[reportSubType]=SUMMARY&filter[reportType]=SALES&filter[vendorNumber]=string&filter[version]=string
Territories
- GETterritories-get_collection
/v1/territories?fields[territories]=currency&limit=0
UserInvitations
- GETuserInvitations-get_collection
/v1/userInvitations?filter[email]=string&filter[roles]=ADMIN&filter[visibleApps]=string&sort=email&fields[userInvitations]=allAppsVisible&limit=0&include=visibleApps&fields[apps]=appInfos&limit[visibleApps]=0 - POSTuserInvitations-create_instance
/v1/userInvitations - GETuserInvitations-get_instance
/v1/userInvitations/:id?fields[userInvitations]=allAppsVisible&include=visibleApps&fields[apps]=appInfos&limit[visibleApps]=0 - DELETEuserInvitations-delete_instance
/v1/userInvitations/:id - GETuserInvitations-visibleApps-get_to_many_related
/v1/userInvitations/:id/visibleApps?fields[apps]=appInfos&limit=0
Users
- GETusers-get_collection
/v1/users?filter[roles]=ADMIN&filter[username]=string&filter[visibleApps]=string&sort=lastName&fields[users]=allAppsVisible&limit=0&include=visibleApps&fields[apps]=appInfos&limit[visibleApps]=0 - GETusers-get_instance
/v1/users/:id?fields[users]=allAppsVisible&include=visibleApps&fields[apps]=appInfos&limit[visibleApps]=0 - DELETEusers-delete_instance
/v1/users/:id - PATCHusers-update_instance
/v1/users/:id - GETusers-visibleApps-get_to_many_relationship
/v1/users/:id/relationships/visibleApps?limit=0 - POSTusers-visibleApps-create_to_many_relationship
/v1/users/:id/relationships/visibleApps - DELETEusers-visibleApps-delete_to_many_relationship
/v1/users/:id/relationships/visibleApps - PATCHusers-visibleApps-replace_to_many_relationship
/v1/users/:id/relationships/visibleApps - GETusers-visibleApps-get_to_many_related
/v1/users/:id/visibleApps?fields[apps]=appInfos&limit=0
API details
- Base URL
https://api.appstoreconnect.apple.com- Authentication
- A bearer token in the Authorization header
- Operations
- 252 operations on 175 pathsGET 149POST 37DELETE 34PATCH 32
1 marked deprecated - Main resources
- Builds 21Apps 19BetaTesters 15AppStoreVersions 14BetaGroups 14AppInfos 10Users 9BundleIds 8Profiles 7AppPreviewSets 6
- Response formats
application/jsongzip- Description format
- OpenAPI 3.0.1, API version
1.4.1 - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the App Store Connect API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the App Store Connect API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ageRatingDeclarations-update_instance” (PATCH /v1/ageRatingDeclarations/:id), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the App Store Connect API?
App Store Connect API endpoints from Apple It is listed under Developer tools and has 252 endpoints.
Who publishes the App Store Connect API?
It is listed from Apple's public API description (an OpenAPI document), not published by Apple on Swastik Codes. Anyone who controls apple.com can claim the profile by adding a DNS TXT record.
What is the base URL of the App Store Connect API?
Requests go to https://api.appstoreconnect.apple.com. Endpoint paths are added to this base URL.
How do I authenticate with the App Store Connect API?
With A bearer token in the Authorization header.
How many endpoints does the App Store Connect API have?
252 operations on 175 paths (149 GET, 37 POST, 34 DELETE, 32 PATCH). The largest groups are Builds, Apps, BetaTesters, AppStoreVersions.
Is forking the App Store Connect API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.