Contents

Read app clip card image information for a localized default app clip experience

Get the image that appears on the App Clip card, specific to a locale, for a default App Clip experience.

URL

GET https://api.appstoreconnect.apple.com/v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the default App Clip experience localization resource ID from the Read localization information for a default app clip experience response.

Query Parameters

NameTypeDescription
fields[appClipHeaderImages] Optional[string]

Additional fields to include for each app clip header image resource returned by the response.

fields[appClipDefaultExperienceLocalizations] Optional[string]

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

include Optional[string]

The relationship data to include in the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppClipHeaderImageResponse

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

Getting Metadata for Your Default App Clip Experience