GET /asset/v1/content/assets
Gets an asset collection by simple $filter parameters.
Name | Type | Description | |
---|---|---|---|
$page | number | Page number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the $pagesize parameter. | |
$pagesize | number | Number of results per page to return. Typically provided along with the $page parameter. | |
$orderBy | string | Determines 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. | |
$filter | string | Filter by an asset's property using a simple operator and value. | |
$fields | string | Comma delimited string of asset properties used to reduce the size of your results to only the properties you need. |
Status | Name | Type | Description |
---|---|---|---|
200 | A collection of assets | ||
CustomerKey | string | Reference to customer's private ID/name for the asset | |
ContentType | string | The type that the content attribute will be in | |
Data | object | Property bag containing the asset data | |
AssetType | object | The type of the asset saved as a name/ID pair | |
Version | number | The version of the asset | |
Locked | boolean | Specifies if the asset can be modified or not | |
FileProperties | object | Stores the different properties that this asset refers to if it is a file type | |
Name | string | Name of the asset, set by the client. 200 character maximum. | |
Description | string | Description of the asset, set by the client | |
Category | object | ID of the category the asset belongs to | |
Tags | array | List of tags associated with the asset | |
Content | string | The actual content of the asset | |
Design | string | Fallback for display when neither content nor supercontent are provided | |
SuperContent | string | Content that supersedes content in terms of display | |
CustomFields | object | Custom fields within an asset | |
Views | object | Views within an asset | |
Blocks | object | Blocks within the asset | |
MinBlocks | number | Minimum number of blocks within an asset | |
MaxBlocks | number | Maximum number of blocks within an asset | |
Channels | object | List of channels that are allowed to use this asset | |
AllowedBlocks | array | List of blocks that are allowed in the asset | |
Slots | object | Slots within the asset | |
BusinessUnitAvailability | object | A dictionary of member IDs that have been granted access to the asset | |
sharingProperties | object | Allows you to share content with one or more business units that have Content Builder Sharing enabled. See Sharing for additional information. | |
sharingProperties.sharedWith | object | List of MID IDs the asset is shared with | |
sharingProperties.sharingType | string | Indicates the permission that you are granting to the list of MIDs in sharedWith. Possible values are view, edit, or local. | |
Template | object | Template the asset follows | |
File | string | Base64-encoded string of a file associated with an asset | |
GenerateFrom | string | Tells the sending compiler what view to use for generating this view's content | |
400 | Bad request | ||
Message | string | The error message | |
ErrorCode | number | The specific error code | |
Documentation | string | Any specific documentation for the error | |
403 | Permission error | ||
Message | string | The error message | |
ErrorCode | number | The specific error code | |
Documentation | string | Any 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
Operator | Description |
---|---|
eq | Equals. Compares numbers and strings. |
neq | Is not equal to. Compares numbers and strings. |
lt | Is less than. Compares numbers only. |
lte | Is less than or equal to. Compares numbers only. |
gt | Is greater than. Compares numbers only. |
gte | Is greater than or equal to. Compares numbers only. |
like | Is similar to. Compares strings only. |