Contents

Get the default app clip experience for an app store version

Get the default App Clip experience for an App Store version of your app.

URL

GET https://api.appstoreconnect.apple.com/v1/appStoreVersions/{id}/appClipDefaultExperience

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the App Store version resource ID from the List all app store versions for an app response.

Query Parameters

NameTypeDescription
fields[appClipDefaultExperienceLocalizations] Optional[string]

Additional fields to include for each App Clip default experience localization resource returned by the response.

fields[appClipDefaultExperiences] Optional[string]

Additional fields to include for each App Clip default experience resource returned by the response.

include Optional[string]

The relationship data to include in the response.

limit[appClipDefaultExperienceLocalizations] Optionalinteger

The maximum number of related App Clip default experience localization resources to return.

fields[appClips] Optional[string]

Additional fields to include for each App Clip resource returned by the response.

fields[appClipAppStoreReviewDetails] Optional[string]

Additional fields to include for each App Clip App Store review detail resource returned by the response.

fields[appStoreVersions] Optional[string]

Additional fields to include for each App Store version resource returned by the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppClipDefaultExperienceResponse

The request completed successfully.

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

429
Content-Type: application/json
ErrorResponse

See Also

Attaching a Default App Clip Experience to a Version