Skip to main content
Server path: /bynder-assets | Type: Application | PCID required: Yes

Tools

ToolDescription
bynder_assets_add_assets_to_collectionAdd assets to a collection
bynder_assets_add_tag_to_assetsAdd tag to assets
bynder_assets_create_asset_usageCreate asset usage record
bynder_assets_create_collectionCreate a collection
bynder_assets_delete_assetDelete an asset
bynder_assets_delete_asset_usageDelete asset usage record
bynder_assets_delete_collectionDelete a collection
bynder_assets_get_assetRetrieve a specific asset
bynder_assets_get_asset_download_urlRetrieve asset download location
bynder_assets_get_asset_item_download_urlRetrieve specific asset item download location
bynder_assets_get_collectionRetrieve a specific collection
bynder_assets_list_asset_usageRetrieve asset usage
bynder_assets_list_assetsRetrieve assets
bynder_assets_list_collection_assetsRetrieve assets of a collection
bynder_assets_list_collectionsRetrieve collections
bynder_assets_list_tagsRetrieve tags
bynder_assets_list_trashed_assetsRetrieve recently removed assets
bynder_assets_modify_assetModify an asset
bynder_assets_modify_collectionModify a collection
bynder_assets_remove_assets_from_collectionRemove assets from a collection
bynder_assets_remove_tag_from_assetsRemove tag from assets
bynder_assets_search_similar_assetsSearch for similar assets
bynder_assets_share_collectionShare a collection

bynder_assets_add_assets_to_collection

Add assets to a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier
datastringYesJSON array of asset IDs to add to the collection

bynder_assets_add_tag_to_assets

Add tag to assets Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTag identifier
datastringYesJSON array of asset IDs to tag

bynder_assets_create_asset_usage

Create asset usage record Parameters:
ParameterTypeRequiredDefaultDescription
additionalstringNoAdditional information about the usage
asset_idstringYesAsset identifier
integration_idstringYesIntegration identifier
uristringYesURI where the asset is used

bynder_assets_create_collection

Create a collection Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoDescription of the collection
isPublicbooleanNoWhether the collection is publicly accessible
namestringYesName of the collection

bynder_assets_delete_asset

Delete an asset Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAsset identifier

bynder_assets_delete_asset_usage

Delete asset usage record Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringYesAsset identifier
integration_idstringYesIntegration identifier
uristringYesURI of the usage to delete

bynder_assets_delete_collection

Delete a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier

bynder_assets_get_asset

Retrieve a specific asset Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAsset identifier

bynder_assets_get_asset_download_url

Retrieve asset download location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAsset identifier

bynder_assets_get_asset_item_download_url

Retrieve specific asset item download location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAsset identifier
itemIdstringYesMedia item identifier for the specific derivative

bynder_assets_get_collection

Retrieve a specific collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier

bynder_assets_list_asset_usage

Retrieve asset usage Parameters:
ParameterTypeRequiredDefaultDescription
asset_idstringNoFilter by asset identifier

bynder_assets_list_assets

Retrieve assets Parameters:
ParameterTypeRequiredDefaultDescription
keywordstringNoSearch on filenames, tags, extensions, collection names, and other asset properties
typestringNoFilter by asset type: image, document, audio, video, or 3d
brandIdstringNoFilter by brand identifier
subBrandIdstringNoFilter by sub-brand identifier
categoryIdstringNoFilter by category identifier
collectionIdstringNoFilter by collection identifier
idsstringNoComma-separated list of asset identifiers to retrieve specific assets
tagsstringNoComma-separated tag values to filter by
orientationstringNoFilter by asset orientation
limitedbooleanNoFilter for assets marked as limited usage
archivebooleanNoFilter for archived assets
isPublicbooleanNoFilter for publicly marked assets
dateCreatedstringNoFilter assets created after this ISO8601 date
dateCreatedTostringNoEnd date range for dateCreated filter
dateModifiedstringNoFilter assets modified after this ISO8601 date
dateModifiedTostringNoEnd date range for dateModified filter
orderBystringNoSort results, e.g. ‘dateCreated desc’, ‘name asc’
limitintegerNoMaximum results per page (default 50, max 1000)
pageintegerNoPage number for pagination (default 1)
countbooleanNoInclude count results in response
totalbooleanNoInclude total count of matching results
includeMediaItemsbooleanNoInclude all media item derivatives per asset

bynder_assets_list_collection_assets

Retrieve assets of a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier
limitintegerNoMaximum results per page
pageintegerNoPage number for pagination

bynder_assets_list_collections

Retrieve collections Parameters:
ParameterTypeRequiredDefaultDescription
keywordstringNoSearch collections by name or content
idsstringNoComma-separated collection IDs to retrieve specific collections
isPublicbooleanNoFilter by public collections only
orderBystringNoSort results, e.g. ‘dateCreated desc’, ‘name asc’
limitintegerNoMaximum results per page (default 50, max 1000)
pageintegerNoPage number for pagination (default 1)
countbooleanNoInclude total count in response
minCountintegerNoReturn only collections with at least this many assets

bynder_assets_list_tags

Retrieve tags Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum results per page
pageintegerNoPage number for pagination
keywordstringNoSearch tags by keyword
orderBystringNoSort order for results

bynder_assets_list_trashed_assets

Retrieve recently removed assets

bynder_assets_modify_asset

Modify an asset Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAsset identifier
archivebooleanNoSet the archived state of the asset
brandIdstringNoBrand identifier to assign the asset to
copyrightstringNoCopyright information
datePublishedstringNoPublication datetime in ISO8601 format
descriptionstringNoAsset description
isPublicbooleanNoSet the public state (WARNING - irreversible once set to true)
limitedbooleanNoSet the limited usage state of the asset
namestringNoName of the asset
tagsstringNoComma-separated tags (overwrites current tags list)

bynder_assets_modify_collection

Modify a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier
descriptionstringNoUpdated description of the collection
isPublicbooleanNoWhether the collection is publicly accessible
namestringNoUpdated name of the collection

bynder_assets_remove_assets_from_collection

Remove assets from a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier
deleteIdsstringYesComma-separated asset IDs to remove from the collection

bynder_assets_remove_tag_from_assets

Remove tag from assets Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTag identifier
deleteIdsstringYesComma-separated asset IDs to remove the tag from

bynder_assets_search_similar_assets

Search for similar assets Parameters:
ParameterTypeRequiredDefaultDescription
assetIdstringYesID of the asset to find similar assets for
limitintegerNoMaximum number of results to return

bynder_assets_share_collection

Share a collection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCollection identifier
collectionOptionsstringNoSharing options
loginRequiredbooleanNoWhether login is required to access the shared collection
recipientsstringYesComma-separated email addresses to share with