v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Media

Retrieve assets

original is only returned for assets marked as public and requires the account to have the seoBaseUrl setting configured.

get/api/v4/media/

Query parameters

brandIdstring uuid

Brand id, can be retrieved using the Retrieve brands and subbrands call.

subBrandIdstring uuid

Sub-brand id, can be retrieved using the Retrieve brands and subbrands call.

categoryIdstring uuid

Category id, can be retrieved using the Retrieve categories call.

collectionIdstring uuid

Collection id, can be retrieved using the Retrieve collections call.

idstring uuid

Asset id, will return the asset for that id.

idsstring

Comma-separated list of asset ids. Will return an asset for each existing id.

propertyOptionIdstring

Comma-separated list of (metaproperty) option ids, can be retrieved using the Retrieve metaproperties call.

tagsstring

Comma-separated list of tags, can be retrieved using the Retrieve tags call.

type'image' | 'document' | 'audio' | 'video' | '3d'

Comma-separated list of asset types.

orientation'square' | 'portrait' | 'landscape'

Comma-separated list of asset orientation.

property_NAMEstring

Metaproperty option name or comma-separated list ids of metaproperty options for that metaproperty. Beware that NAME should be replaced with the actual metaproperty name. This is an AND operation when passing multiple values. If a Date type metaproperty is added, retrieving assets using the dates for that metaproperty is not supported.

limitedboolean

Indicates whether or not the response should only contain assets marked as "limited usage".

archiveboolean

Indicates whether or not the response should only contain archived assets.

isPublicboolean

Indicates whether or not the response should only contain assets marked as public.

keywordstring

Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents.

dateCreatedstring date-time

Retrieve assets created after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

dateCreatedTostring date-time

Set a date range together with the "dateCreated" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

dateCreatedOnstring date-time

Retrieve assets created on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

dateModifiedstring date-time

Retrieve assets modified after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

dateModifiedTostring date-time

Set a date range together with the "dateModified" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

dateModifiedOnstring date-time

Retrieve assets modified on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.

orderBy'dateCreated asc' | 'dateModified asc' | 'datePublished asc' | 'name asc' | 'dateCreated desc' | 'dateModified desc' | 'datePublished desc' | 'name desc'

Order of the returned list of assets.

limitinteger

Maximum number of results.

pageinteger

Offset page for results: return the N-th set of limit-results.

countboolean

Indicating whether or not the response should include count results.

totalboolean

Indicating whether or not the response should include the total count of results.

includeMediaItemsboolean

Indicating whether or not the response should include all the different media items (derivatives) available for each asset.

includeVersionNumberboolean

Indicating whether or not the response should include the active version number.

cursorstring

cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.

Headers

Authorizationstring required

OAuth 2.0 Bearer access token.

Response

Successful response

dateModifiedstring date-time
propertyOptionsstring[]
typestring
brandIdstring uuid
fileSizeinteger
idstring uuid
heightinteger
descriptionstring
idHashstring
namestring
tagsstring[]
orientationstring
widthinteger
datePublishedstring date-time
copyrightstring
extensionstring[]
userCreatedstring
dateCreatedstring date-time
archiveboolean
property_limitedrightsstring
watermarkedboolean
limitedboolean
isPublicboolean
transformBaseUrlstring
videoPreviewURLsstring[]
originalstring