Contents

List related images

List the image assets in an app’s asset library.

URL

GET https://api.appstoreconnect.apple.com/v1/appAssetLibraries/{id}/images

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource.

Query Parameters

NameTypeDescription
filter[category] Optional[string]

Filter the returned app asset library images by category.

filter[state] Optional[string]

Filter the returned app asset library images by state.

filter[referenceName] Optional[string]

Filter the returned app asset library images by reference name.

filter[specId] Optional[string]

Filter the returned app asset library images by specification ID.

filter[id] Optional[string]

Filter the returned app asset library images by resource ID.

sort Optional[string]

Attributes by which to sort.

fields[appAssetLibraryImages] Optional[string]

Additional fields to include for each app asset library image resource returned by the response.

fields[appAssetLibraryPlacements] Optional[string]

Additional fields to include for each app asset library placement resource returned by the response.

limit Optionalinteger

The maximum number of app asset library image resources to return.

include Optional[string]

The relationship data to include in the response.

limit[placements] Optionalinteger

The maximum number of related placement resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppAssetLibraryImagesResponse

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

Mentioned in

Discussion

Example Request and Response

See Also

Getting assets in a library