Contents

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

NameTypeDescription
id Requiredstring

The opaque resource ID that uniquely identifies the App Clip Header Images resource.

Query Parameters

NameTypeDescription
fields[appClipHeaderImages] Optional[string]

Additional fields to include for each App Clip Header Images 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

Managing App Clip Card Images