Get Assets

Retrieves a list of assets.

Query Parameters

vendor_id

string

Vendor ID.

collection_name

string

The collection name that the assets are associated with.

brand

string

The brand that the assets are associated with.

mimetype

enum<string>

The mimetype of the assets.

Available options:

image/jpeg,

image/png,

image/gif,

image/webp,

text/html,

video/mp4,

video/quicktime,

application/json

status

enum<string>

The approval status of the assets.

Available options:

pending_upload,

pending_approval,

upload_error,

approved,

rejected

asset_ids

string[]

The list of asset ids.

next_page

string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

limit

integer

default:

50

The maximum number of items to return per page.

Required range: 1 < x < 100

Response

200 - application/json

assets

object[]

required

List of assets

Show child attributes

assets.brands

string[]

required

The brands that the asset is associated with.

assets.collections

string[]

required

The collections that the asset is associated with.

assets.id

string

required

The id of the asset.

assets.isExternal

boolean

required

Indicates if the asset is externally hosted.

assets.metadata

object

required

The metadata associated with the asset.

Show child attributes

assets.metadata.{key}

string

assets.name

string

required

The name of the asset.

assets.productIds

string[]

required

The product ids that the asset is associated with.

assets.status

enum<string>

required

Approval status of the asset

Available options:

pending_upload,

pending_approval,

upload_error,

approved,

rejected

assets.mimetype

string

The mimetype of the asset.

assets.url

string

The url of the asset.

Minimum length: 1

hasMore

boolean

required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

nextPage

string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1