iOS AppStoreVersions API
The AppStoreVersions API from iOS — 26 operation(s) for appstoreversions.
iOS AppStoreVersions API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AppStoreVersions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.
This API exposes 30 operations across 26 paths, and defines 80 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.
Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.
30 operations
26 paths
80 schemas
1 DELETE25 GET3 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
iOS AppStoreVersions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (itc-bearer-token).
By default, every request must be authenticated.
Paths & Operations 30
Across 26 paths, the API surfaces 30 operations — 1 DELETE, 25 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
AppStoreVersions 30
POST
/v1/appStoreVersions
Create App Store Versions
GET
/v1/appStoreVersions/{id}
Get App Store Versions
PATCH
/v1/appStoreVersions/{id}
Update App Store Versions
DELETE
/v1/appStoreVersions/{id}
Delete App Store Versions
GET
/v1/appStoreVersions/{id}/relationships/alternativeDistributionPackage
Get Related App Store Versions / Alternative Distribution Package
GET
/v1/appStoreVersions/{id}/alternativeDistributionPackage
Get Related App Store Versions / Alternative Distribution Package
GET
/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience
Get Related App Store Versions / App Clip Default Experience
PATCH
/v1/appStoreVersions/{id}/relationships/appClipDefaultExperience
Update Related App Store Versions / App Clip Default Experience
GET
/v1/appStoreVersions/{id}/appClipDefaultExperience
Get Related App Store Versions / App Clip Default Experience
GET
/v1/appStoreVersions/{id}/relationships/appStoreReviewDetail
Get Related App Store Versions / App Store Review Detail
GET
/v1/appStoreVersions/{id}/appStoreReviewDetail
Get Related App Store Versions / App Store Review Detail
GET
/v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsdeprecated
List Related App Store Versions / App Store Version Experiments
GET
/v1/appStoreVersions/{id}/appStoreVersionExperimentsdeprecated
List Related App Store Versions / App Store Version Experiments
GET
/v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsV2
List Related App Store Versions / App Store Version Experiments V2
GET
/v1/appStoreVersions/{id}/appStoreVersionExperimentsV2
List Related App Store Versions / App Store Version Experiments V2
GET
/v1/appStoreVersions/{id}/relationships/appStoreVersionLocalizations
List Related App Store Versions / App Store Version Localizations
GET
/v1/appStoreVersions/{id}/appStoreVersionLocalizations
List Related App Store Versions / App Store Version Localizations
GET
/v1/appStoreVersions/{id}/relationships/appStoreVersionPhasedRelease
Get Related App Store Versions / App Store Version Phased Release
GET
/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease
Get Related App Store Versions / App Store Version Phased Release
GET
/v1/appStoreVersions/{id}/relationships/appStoreVersionSubmissiondeprecated
Get Related App Store Versions / App Store Version Submission
GET
/v1/appStoreVersions/{id}/appStoreVersionSubmissiondeprecated
Get Related App Store Versions / App Store Version Submission
GET
/v1/appStoreVersions/{id}/relationships/build
Get Related App Store Versions / Build
PATCH
/v1/appStoreVersions/{id}/relationships/build
Update Related App Store Versions / Build
GET
/v1/appStoreVersions/{id}/build
Get Related App Store Versions / Build
GET
/v1/appStoreVersions/{id}/relationships/customerReviews
List Related App Store Versions / Customer Reviews
GET
/v1/appStoreVersions/{id}/customerReviews
List Related App Store Versions / Customer Reviews
GET
/v1/appStoreVersions/{id}/relationships/gameCenterAppVersion
Get Related App Store Versions / Game Center App Version
GET
/v1/appStoreVersions/{id}/gameCenterAppVersion
Get Related App Store Versions / Game Center App Version
GET
/v1/appStoreVersions/{id}/relationships/routingAppCoverage
Get Related App Store Versions / Routing App Coverage
GET
/v1/appStoreVersions/{id}/routingAppCoverage
Get Related App Store Versions / Routing App Coverage
Schemas 80
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are AppStoreVersionExperiment (5 properties), AppStoreReviewDetail (5 properties), AppStoreVersionExperimentV2 (5 properties), AppClipAppStoreReviewDetail (5 properties). Each schema is shown below with its type and property counts.
AppClip
object
5 properties
2 required
ErrorSourceParameter
object
1 property
1 required
AppVersionState
string
AppClipAction
string
AppStoreVersionAppStoreVersionLocalizationsLinkagesResponse
object
3 properties
2 required
AlternativeDistributionPackageResponse
object
3 properties
2 required
AppStoreVersionBuildLinkageRequest
object
1 property
1 required
DocumentLinks
object
1 property
1 required
AlternativeDistributionPackage
object
5 properties
2 required
PhasedReleaseState
string
AppStoreVersionPhasedRelease
object
4 properties
2 required
AppStoreVersionSubmission
object
4 properties
2 required
AppStoreVersionAppStoreVersionPhasedReleaseLinkageResponse
object
2 properties
2 required
AppClipDefaultExperience
object
5 properties
2 required
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties
1 required
AppStoreVersionExperimentTreatment
object
5 properties
2 required
TerritoryCode
string
AppStoreVersionGameCenterAppVersionLinkageResponse
object
2 properties
2 required
AppClipDefaultExperienceResponse
object
3 properties
2 required
AppScreenshotSet
object
5 properties
2 required
AppStoreVersionCreateRequest
object
1 property
1 required
AppStoreVersionAppStoreVersionExperimentsV2LinkagesResponse
object
3 properties
2 required
ErrorResponse
object
1 property
AppClipDefaultExperienceLocalization
object
5 properties
2 required
GameCenterAppVersionResponse
object
3 properties
2 required
ChecksumAlgorithm
string
CustomerReview
object
5 properties
2 required
ErrorSourcePointer
object
1 property
1 required
RoutingAppCoverage
object
5 properties
2 required
PagingInformation
object
1 property
1 required
ScreenshotDisplayType
string
GameCenterAppVersion
object
5 properties
2 required
AlternativeDistributionPackageVersion
object
5 properties
2 required
ErrorLinks
object
2 properties
RoutingAppCoverageResponse
object
3 properties
2 required
AppMediaAssetState
object
3 properties
AppStoreVersionAppStoreVersionSubmissionLinkageResponse
object
2 properties
2 required
Platform
string
Checksums
object
2 properties
AppStoreVersionAppStoreReviewDetailLinkageResponse
object
2 properties
2 required
AppStoreVersionExperiment
object
5 properties
2 required
AppStoreVersionAppClipDefaultExperienceLinkageResponse
object
2 properties
2 required
App
object
5 properties
2 required
AppStoreReviewDetail
object
5 properties
2 required
RelationshipLinks
object
2 properties
AppStoreVersionExperimentV2
object
5 properties
2 required
AppClipAppStoreReviewDetail
object
5 properties
2 required
AppStoreVersionUpdateRequest
object
1 property
1 required
AppStoreVersionAppStoreVersionExperimentsLinkagesResponse
object
3 properties
2 required
BuildAudienceType
string
AppStoreReviewDetailResponse
object
3 properties
2 required
AppStoreVersionPhasedReleaseWithoutIncludesResponse
object
2 properties
2 required
AppKeyword
object
3 properties
2 required
BuildWithoutIncludesResponse
object
2 properties
2 required
AppStoreVersionRoutingAppCoverageLinkageResponse
object
2 properties
2 required
AppStoreVersionSubmissionResponse
object
3 properties
2 required
HttpHeader
object
2 properties
AppStoreVersionCustomerReviewsLinkagesResponse
object
3 properties
2 required
ResourceLinks
object
1 property
AppStoreVersionLocalizationsResponse
object
4 properties
2 required
AppStoreReviewAttachment
object
5 properties
2 required
CustomerReviewResponseV1
object
5 properties
2 required
UploadOperation
object
5 properties
PreviewType
string
AppStoreVersionAppClipDefaultExperienceLinkageRequest
object
1 property
1 required
AppStoreVersionExperimentsResponse
object
4 properties
2 required
Build
object
5 properties
2 required
AppStoreVersionExperimentsV2Response
object
4 properties
2 required
SubscriptionStatusUrlVersion
string
AppStoreVersionLocalization
object
5 properties
2 required
AppStoreVersion
object
5 properties
2 required
AppStoreVersionBuildLinkageResponse
object
2 properties
2 required
AppStoreVersionResponse
object
3 properties
2 required
CustomerReviewsResponse
object
4 properties
2 required
AppStoreVersionAlternativeDistributionPackageLinkageResponse
object
2 properties
2 required
AppPreviewSet
object
5 properties
2 required
AppMediaStateError
object
2 properties
Territory
object
4 properties
2 required
AppStoreVersionState
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from iOS 12
Other APIs iOS publishes across the network.
App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API
#AppStoreVersions