Contents

List all background assets for an app

Get information about the Apple-hosted background assets for a specific app.

URL

GET https://api.appstoreconnect.apple.com/v1/apps/{id}/backgroundAssets

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response.

Query Parameters

NameTypeDescription
fields[backgroundAssetVersions] Optional[string]

Additional fields to include for each background asset version resource that the response returns.

fields[backgroundAssets] Optional[string]

Additional fields to include for each background asset resource that the response returns.

filter[assetPackIdentifier] Optional[string]

Filter the returned background assets by asset pack identifier.

include Optional[string]

The relationship data to include in the response.

limit Optionalinteger

The maximum number of background asset resources to return.

fields[apps] Optional[string]
filter[archived] Optional[string]
filter[versions.locale] Optional[string]
filter[versions.platforms] Optional[string]
sort Optional[string]

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
BackgroundAssetsResponse

400Bad Request
Content-Type: application/json
ErrorResponse

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Mentioned in

See Also

Getting background asset information