GET /asset/v1/content/assets

Gets an asset collection by simple $filter parameters.

NameTypeDescription
$pagenumberPage number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the $pagesize parameter.
$pagesizenumberNumber of results per page to return. Typically provided along with the $page parameter.
$orderBystringDetermines which asset property to use for sorting, and also determines the direction in which to sort the data. If you don't provide the $orderBy parameter, the results are sorted by asset ID in ascending order.
$filterstringFilter by an asset's property using a simple operator and value.
$fieldsstringComma delimited string of asset properties used to reduce the size of your results to only the properties you need.
StatusNameTypeDescription
200  A collection of assets
 CustomerKeystringReference to customer's private ID/name for the asset
 ContentTypestringThe type that the content attribute will be in
 DataobjectProperty bag containing the asset data
 AssetTypeobjectThe type of the asset saved as a name/ID pair
 VersionnumberThe version of the asset
 LockedbooleanSpecifies if the asset can be modified or not
 FilePropertiesobjectStores the different properties that this asset refers to if it is a file type
 NamestringName of the asset, set by the client. 200 character maximum.
 DescriptionstringDescription of the asset, set by the client
 CategoryobjectID of the category the asset belongs to
 TagsarrayList of tags associated with the asset
 ContentstringThe actual content of the asset
 DesignstringFallback for display when neither content nor supercontent are provided
 SuperContentstringContent that supersedes content in terms of display
 CustomFieldsobjectCustom fields within an asset
 ViewsobjectViews within an asset
 BlocksobjectBlocks within the asset
 MinBlocksnumberMinimum number of blocks within an asset
 MaxBlocksnumberMaximum number of blocks within an asset
 ChannelsobjectList of channels that are allowed to use this asset
 AllowedBlocksarrayList of blocks that are allowed in the asset
 SlotsobjectSlots within the asset
 BusinessUnitAvailabilityobjectA dictionary of member IDs that have been granted access to the asset
 sharingPropertiesobjectAllows you to share content with one or more business units that have Content Builder Sharing enabled. See Sharing for additional information.
 sharingProperties.sharedWithobjectList of MID IDs the asset is shared with
 sharingProperties.sharingTypestringIndicates the permission that you are granting to the list of MIDs in sharedWith. Possible values are view, edit, or local.
 TemplateobjectTemplate the asset follows
 FilestringBase64-encoded string of a file associated with an asset
 GenerateFromstringTells the sending compiler what view to use for generating this view's content
    
400  Bad request
 MessagestringThe error message
 ErrorCodenumberThe specific error code
 DocumentationstringAny specific documentation for the error
    
403  Permission error
 MessagestringThe error message
 ErrorCodenumberThe specific error code
 DocumentationstringAny specific documentation for the error

Sort Syntax

The sort syntax is the asset property name followed by the order direction, either asc or desc, with a space in between. Sort by multiple property names by separating each sequence with a comma. This example sorts by name in descending order: /asset/v1/content/assets?$orderBy=name asc.

Filter Syntax

Each filter is separated by %20. To use AND and OR operators or to filter by sub-properties, use the POST /asset/v1/content/assets/query resource. The following example filters all assets whose name is similar to the value hello world: /asset/v1/content/assets?$filter=Name%20like%20'hello%20world'

Filter Operators

OperatorDescription
eqEquals. Compares numbers and strings.
neqIs not equal to. Compares numbers and strings.
ltIs less than. Compares numbers only.
lteIs less than or equal to. Compares numbers only.
gtIs greater than. Compares numbers only.
gteIs greater than or equal to. Compares numbers only.
likeIs similar to. Compares strings only.