Read the app clip card image
Get the image that appears on the App Clip card of a default App Clip experience.
URL
GET https://api.appstoreconnect.apple.com/v1/appClipHeaderImages/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. Obtain the app clip header image resource ID from the Create an app clip card image for a default app clip experience response. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[appClipHeaderImages] Optional | [string] | Additional fields to include for each app clip header image resource returned by the response. |
include Optional | [string] | The relationship data to include in the response. |
fields[appClipDefaultExperienceLocalizations] Optional | [string] |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppClipHeaderImageResponse | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |