How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 App Previews. 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.2.0, 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.2.0
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 AppPreviewSet (5 properties), UploadOperation (5 properties), AppPreview (5 properties), AppMediaPreviewFrameImageState (3 properties). Each schema is shown below with its type and property counts.

AppMediaVideoState
object
3 properties
ErrorSourcePointer
object
1 property 1 required
UploadOperation
object
5 properties
AppMediaPreviewFrameImageState
object
3 properties
AppPreviewCreateRequest
object
1 property 1 required
ErrorResponse
object
1 property
RelationshipLinks
object
2 properties
AppPreviewUpdateRequest
object
1 property 1 required
PreviewFrameImage
object
2 properties
DocumentLinks
object
1 property 1 required
AppMediaAssetState
object
3 properties
PreviewType
string
ImageAsset
object
3 properties
ResourceLinks
object
1 property
AppPreviewResponse
object
3 properties 2 required
AppPreview
object
5 properties 2 required
HttpHeader
object
2 properties
AppPreviewSet
object
5 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
PagingInformation
object
1 property 1 required
AppMediaStateError
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
Where this information came from

This is an independent, third-party profile of iOS AppPreviews API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.