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

The AppClips API from iOS — 5 operation(s) for appclips.

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

Tagged areas include AppClips. 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 5 operations across 5 paths, and defines 34 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/.

5 operations 5 paths 34 schemas 5 GET

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 AppClips 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 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

AppClips 5
GET
/v1/appClips/{id}
Get App Clips
appClips_getInstance 6 params → 400401403404200429
GET
/v1/appClips/{id}/relationships/appClipAdvancedExperiences
List Related App Clips / App Clip Advanced Experiences
appClips_appClipAdvancedExperiences_getToManyRelationship 2 params → 400401403404200429
GET
/v1/appClips/{id}/appClipAdvancedExperiences
List Related App Clips / App Clip Advanced Experiences
appClips_appClipAdvancedExperiences_getToManyRelated 11 params → 400401403404200429
GET
/v1/appClips/{id}/relationships/appClipDefaultExperiences
List Related App Clips / App Clip Default Experiences
appClips_appClipDefaultExperiences_getToManyRelationship 2 params → 400401403404200429
GET
/v1/appClips/{id}/appClipDefaultExperiences
List Related App Clips / App Clip Default Experiences
appClips_appClipDefaultExperiences_getToManyRelated 10 params → 400401403404200429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are AppClipAdvancedExperience (5 properties), AppClip (5 properties), App (5 properties), AppStoreVersion (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
AppClipAdvancedExperienceLocalization
object
4 properties 2 required
AppClip
object
5 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppClipAppClipDefaultExperiencesLinkagesResponse
object
3 properties 2 required
AppVersionState
string
AppClipAction
string
AppMediaAssetState
object
3 properties
Platform
string
DocumentLinks
object
1 property 1 required
UploadOperation
object
5 properties
AppClipAdvancedExperience
object
5 properties 2 required
ErrorResponse
object
1 property
App
object
5 properties 2 required
AppClipDefaultExperienceLocalization
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
AppClipAppStoreReviewDetail
object
5 properties 2 required
AppStoreVersion
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
AppClipDefaultExperiencesResponse
object
4 properties 2 required
PagingInformation
object
1 property 1 required
AppClipAppClipAdvancedExperiencesLinkagesResponse
object
3 properties 2 required
AppClipAdvancedExperienceLanguage
string
AppClipAdvancedExperienceImage
object
4 properties 2 required
AppClipResponse
object
3 properties 2 required
AppClipAdvancedExperiencesResponse
object
4 properties 2 required
AppClipDefaultExperience
object
5 properties 2 required
AppMediaStateError
object
2 properties
AppStoreVersionState
string
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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