Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS AppPreviews API

The AppPreviews API from iOS — 2 operation(s) for apppreviews.

iOS AppPreviews API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AppPreviews. 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 4 operations across 2 paths, and defines 22 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/.

4 operations 2 paths 22 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS AppPreviews 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

AppPreviews 4
POST
/v1/appPreviews
Create App Previews
appPreviews_createInstance body → 400401403422201409429
GET
/v1/appPreviews/{id}
Get App Previews
appPreviews_getInstance 4 params → 400401403404200429
PATCH
/v1/appPreviews/{id}
Update App Previews
appPreviews_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/appPreviews/{id}
Delete App Previews
appPreviews_deleteInstance 1 param → 400401403404204429

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are UploadOperation (5 properties), AppPreview (5 properties), AppPreviewSet (5 properties), AppMediaAssetState (3 properties). Each schema is shown below with its type and property counts.

AppPreviewCreateRequest
object
1 property 1 required
ImageAsset
object
3 properties
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppMediaPreviewFrameImageState
object
3 properties
AppMediaAssetState
object
3 properties
DocumentLinks
object
1 property 1 required
PreviewFrameImage
object
2 properties
UploadOperation
object
5 properties
PreviewType
string
AppMediaVideoState
object
3 properties
AppPreviewResponse
object
3 properties 2 required
ErrorResponse
object
1 property
AppPreviewUpdateRequest
object
1 property 1 required
RelationshipLinks
object
2 properties
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
AppPreviewSet
object
5 properties 2 required
AppMediaStateError
object
2 properties
AppPreview
object
5 properties 2 required
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-apppreviews-api-openapi.yml Raw ↑

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