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 AppScreenshotSets API

The AppScreenshotSets API from iOS — 4 operation(s) for appscreenshotsets.

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

Tagged areas include AppScreenshotSets. 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 6 operations across 4 paths, and defines 25 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/.

6 operations 4 paths 25 schemas 1 DELETE3 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 AppScreenshotSets 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 6

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

AppScreenshotSets 6
POST
/v1/appScreenshotSets
Create App Screenshot Sets
appScreenshotSets_createInstance body → 400401403422201409429
GET
/v1/appScreenshotSets/{id}
Get App Screenshot Sets
appScreenshotSets_getInstance 8 params → 400401403404200429
DELETE
/v1/appScreenshotSets/{id}
Delete App Screenshot Sets
appScreenshotSets_deleteInstance 1 param → 400401403404204429
GET
/v1/appScreenshotSets/{id}/relationships/appScreenshots
List Related App Screenshot Sets / App Screenshots
appScreenshotSets_appScreenshots_getToManyRelationship 2 params → 400401403404200429
PATCH
/v1/appScreenshotSets/{id}/relationships/appScreenshots
Replace Related App Screenshot Sets / App Screenshots
appScreenshotSets_appScreenshots_replaceToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/appScreenshotSets/{id}/appScreenshots
List Related App Screenshot Sets / App Screenshots
appScreenshotSets_appScreenshots_getToManyRelated 5 params → 400401403404200429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are AppScreenshot (5 properties), AppStoreVersionLocalization (5 properties), AppStoreVersionExperimentTreatmentLocalization (5 properties), AppCustomProductPageLocalization (5 properties). Each schema is shown below with its type and property counts.

ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppScreenshotSetAppScreenshotsLinkagesResponse
object
3 properties 2 required
AppMediaAssetState
object
3 properties
DocumentLinks
object
1 property 1 required
AppScreenshotSet
object
5 properties 2 required
AppScreenshotSetResponse
object
3 properties 2 required
UploadOperation
object
5 properties
ErrorResponse
object
1 property
AppScreenshotSetAppScreenshotsLinkagesRequest
object
1 property 1 required
AppScreenshotSetCreateRequest
object
1 property 1 required
AppStoreVersionExperimentTreatmentLocalization
object
5 properties 2 required
RelationshipLinks
object
2 properties
AppStoreVersionLocalization
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
ScreenshotDisplayType
string
AppCustomProductPageLocalization
object
5 properties 2 required
AppScreenshot
object
5 properties 2 required
AppMediaStateError
object
2 properties
AppScreenshotsResponse
object
4 properties 2 required
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-appscreenshotsets-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