Bynderconnector v1.0

/api/content_access/metaproperties/{metaproperty_id}/

These API calls allow you to set up visibility restrictions on metaproperties

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Metaproperty Id`	The unique identifier of the metaproperty to set access rights for.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Level`	Field to fetch specific permissions

/api/content_access/metaproperties/{metaproperty_id}/

These API calls allow you to set up visibility restrictions on metaproperties

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Metaproperty Id`	The unique identifier of the metaproperty whose access rights should be removed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/content_access/metaproperties/{metaproperty_id}/

These API calls allow you to set up visibility restrictions on metaproperties

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Metaproperty Id`	The unique identifier of the metaproperty whose access rights are requested.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/account/

Retrieve information about the current account, such as account name, plan, and settings.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/account/derivatives/

A derivative is a file that is based on another source, for example, a low-resolution representation of a print-quality photo. During the upload process, Bynder can automatically create pre-defined image derivatives with different dimensions, quality, and format. Bynder can either maintain the original aspect ratio of an image, or crop or pad an image to fit the specified dimensions. We can create smaller versions of your original image asset in both a JPG and PNG file extension. However, the resolution of derivatives can't be larger than the original file.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/{assetId}/

This endpoint will allow you to retrieve all the events performed in a given asset

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	Asset id.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve events performed in a given asset ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/{assetId}.csv

This endpoint will allow you to retrieve all the events performed in a given asset

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	Asset id.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve events performed in a given asset ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/archive

Retrieve analytics data for asset archive events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve archive events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/archive.csv

Retrieve analytics data for asset archive events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve archive events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/create

Retrieve analytics data for asset create events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve create events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/create.csv

Retrieve analytics data for asset create events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve create events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/download

Retrieve analytics data for asset download events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve download events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/download.csv

Retrieve analytics data for asset download events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve download events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/remove

Retrieve analytics data for asset remove events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve remove events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/remove.csv

Retrieve analytics data for asset remove events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve remove events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/view

Retrieve analytics data for asset view events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve view events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/asset/view.csv

Retrieve analytics data for asset view events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve view events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/search/keyword

Retrieve analytics data for search keyword usage in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve keyword events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/search/keyword.csv

Retrieve analytics data for search keyword usage in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve keyword events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/user/{userId}/

This endpoint will allow you to retrieve all the events triggered by a given user

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	User id.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve events triggered by a user ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/user/{userId}.csv

This endpoint will allow you to retrieve all the events triggered by a given user

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	User id.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve events triggered by a user ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/user/login

Retrieve analytics data for user login events in JSON format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve login events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/v7/analytics/api/v1/user/login.csv

Retrieve analytics data for user login events in CSV format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.
`Cursor`	The position in the dataset for the first event retrieved. To be used for pagination purposes.
`Fromdatetime`	Retrieve login events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Todatetime`	Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/media/usage

These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.

Warning: Requires the STATISTICS security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Asset Id`	The identifier of the asset whose usage is being recorded.
`Integration Id`	The identifier of the integration that is using the asset.
`Uri`	The URI where the asset is being used.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Integration Id`	Integration id.
`Asset Id`	Asset id.
`Timestamp`	Datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Uri`	Location.
`Additional`	Additional information.

/api/media/usage

These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.

Warning: Requires the STATISTICS security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Integration Id`	Integration id.
`Asset Id`	Asset id.
`Uri`	Asset location.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/media/usage

These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.

Warning: Requires the STATISTICS security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Asset Id`	Asset id.
`Integration Id`	Integration id.
`Uri`	URI.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/media/usage/sync

This alternative API call allows you to sync all your usage from a single integration.

Warning: Requires the STATISTICS security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Integration Id`	Integration id.
`Uris`	An array of URIs that are part of your integration. These are used to determine if usage should be created, updated or deleted. This list is not stored individually.
`Usages`	A list of usage objects to be synced with the system.

/api/media/options/

These calls allow you to change the metaproperty options attached to an asset.
Warning: Requires VIEW and EDIT access to the asset.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Asset Id`	Id of the asset.
`Metaproperty Id`	Id of the metaproperty from which you want to add options.
`Metaproperty Option Ids`	List of metaproperty option ids you want to add to the asset.

/api/v4/media/{id}/

Warning: Requires the MEDIAREMOVE security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id.
`Versions`	Whether to also delete all versions of the asset (set to 'true' or 'false').
`Stats`	Whether to also delete related statistics data (set to 'true' or 'false').
`Response Type`	The response format expected from the API (e.g. application/json).

/api/media/options/

These calls allow you to change the metaproperty options attached to an asset.
Warning: Requires VIEW and EDIT access to the asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/{id}/

Warning: Requires the MEDIAEDIT security role. Requires the MARKPUBLIC security role in order to change a asset's isPublic state.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id.
`Versions`	Whether to include version data in the modification (set to 'true' or 'false').
`Stats`	Whether to include statistics data in the modification (set to 'true' or 'false').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Name`	Name of the asset, beware the asset will have no name when this is empty.
`Description`	Asset description.
`Copyright`	Copyright information of the asset.
`Brandid`	Id of the brand to save the asset to, can be retrieved using the Retrieve brands and subbrands call.
`Tags`	Comma-separated tags. Tags will be appended to current tags list. If the tag doesn't exist it will be created.
`Metaproperty.id`	Dictionary with (metaproperty) options to set on the asset. Send fields as metaproperty.METAPROPERY_ID with a string of all its (metaproperty) options comma-separated. Note that the list of (metaproperty) options should include all the (metaproperty) options available in the lower hierarchy; meaning it should include the (metaproperty) options of the (metaproperty) options etc.
`Datepublished`	Publication datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Archive`	Indicating the archived state of the asset.
`Archivedate`	Archive datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Limited`	Indicating the limit state of the asset.
`Limiteddate`	Limit datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Watermarkdate`	Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Ispublic`	Indicating the public state of the asset. Warning irreversible, once changed to true it cannot be changed back.

/api/v4/media/

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Brandid`	Brand id, can be retrieved using the Retrieve brands and subbrands call.
`Subbrandid`	Sub-brand id, can be retrieved using the Retrieve brands and subbrands call.
`Categoryid`	Category id, can be retrieved using the Retrieve categories call.
`Collectionid`	Collection id, can be retrieved using the Retrieve collections call.
`Id`	Asset id, will return the asset for that id.
`Ids`	Comma-separated list of asset ids. Will return a asset for each existing id.
`Propertyoptionid`	Comma-separated list of (metaproperty) option ids, can be retrieved using the Retrieve metaproperties call. This parameter searches for assets that contain at least one of the metaproperty options passed in the list.
`Tags`	Comma-separated list of tags, can be retrieved using the Retrieve tags call.
`Type`	Comma-separated list of asset types.
`Orientation`	Comma-separated list of asset orientation.
`Property Name`	Metaproperty option name.OR Comma-separated list ids of metaproperty options for that metaproperty.Note: NAME should be replaced by the Metaproperty name.
`Limited`	Indicates whether or not the response should only contain assets marked as "limited usage". When 0, no filtering happens.
`Archive`	Indicates whether or not the response should only contain archived assets. When 0, no filtering happens.
`Ispublic`	Indicates whether or not the response should only contain assets marked as public.
`Keyword`	Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents. The default order of results is relevance, but can be overriden with the order parameter.
`Datecreated`	Retrieve assets created after this date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Datecreatedto`	Set a date range together with the "dateCreated" parameter.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Datecreatedon`	Retrieve assets created on this specific date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Datemodified`	Retrieve assets modified after this date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Datemodifiedto`	Set a date range together with the "dateModified" parameter.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Datemodifiedon`	Retrieve assets modified on this specific date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Orderby`	Order of the returned list of assets.
`Limit`	Maximum number of results.Maximum: 1000.
`Page`	Offset page for results: return the N-th set of limit-results.
`Count`	Indicating whether or not the response should include count results. This parameter when passed as 1 overrides the total parameter.
`Total`	Indicating whether or not the response should include the total count of results.
`Includemediaitems`	Indicating whether or not the response should include all the different media items (derivatives) available for each asset.
`Includeversionnumber`	Indicating whether or not the response should include the active version number.
`Cursor`	cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.Note: This parameter can only be used if solr-cursor account feature is enabled.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/{id}/

Warning: Requires the STATISTICS security role in order to retrieve views and downloads statistics data in the response, using the stats parameter.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id.
`Versions`	Include information about the different asset media items including versions.
`Stats`	Include information about views and downloads.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/brands/

Retrieve a list of all brands available in the account.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/order/{id}/

Warning: Requires the brandstore.orderadmin.edit security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Order id.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Status`	New status of the order.
`Message`	Message
`Trackingnumber`	Link to trackingnumber

/api/store/orderproducts/{id}

Warning: Requires the brandstore.orderadmin.edit security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Orderline id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/order/

Warning: Requires the brandstore.orderadmin.view security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Page`	Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/order/{id}/products

Warning: Requires the brandstore.orderadmin.edit security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Order id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/order/{orderNumber}/products

Warning: Requires the brandstore.orderadmin.edit security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ordernumber`	The order number without the country code (NA13334).
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/order/{id}/

Warning: Requires the brandstore.orderadmin.view security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Order id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/store/orderproducts/{id}

Warning: Requires the brandstore.orderadmin.view security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Orderline id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/{id}/media/

Warning: Requires the COLLECTIONS security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Deleteids`	A comma-separated list of asset IDs to remove from the collection before adding new ones.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	JSON-serialised list of asset ids to add.

/api/v4/collections/

Warning: To retrieve public collections the collection.public.view security role is required.

Warning: To retrieve collections other users shared/received the INBOXPUBLIC or OUTBOXPUBLIC security role is required.

Warning: To retrieve collections other users created the PUBLICCOLLECTIONS security role is required.Warning: Requires the COLLECTIONS security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	Limit the number of results returned.
`Page`	Specify the page number of results to retrieve.
`Orderby`	Define the order in which results are sorted.
`Ids`	Provide a comma-separated list of collection IDs to filter.
`Count`	Include the total count of items in the response.
`Keyword`	Search collections by keyword.
`Ispublic`	Filter collections by public status (true or false).
`Mincount`	Filter collections with a minimum number of assets.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Collection name.
`Description`	Collection description.

/api/v4/collections/{id}/

Permanently delete a specific collection by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id to be deleted.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/{id}/

Warning: Requires the COLLECTIONS security role. Requires the PUBLISHCOLLECTIONS security role in order to change a collection's isPublic state.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Name`	Collection name.
`Description`	Collection description.
`Ispublic`	Public state of the collection.

/api/v4/collections/{id}/media/

Warning: Requires the COLLECTIONS security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Deleteids`	Comma-separated asset ids to remove from the collection.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/

Warning: To retrieve public collections the collection.public.view security role is required.

Warning: To retrieve collections other users shared/received the INBOXPUBLIC or OUTBOXPUBLIC security role is required.

Warning: To retrieve collections other users created the PUBLICCOLLECTIONS security role is required.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	Maximum number of results.Maximum: 1000.
`Page`	Offset page for results: return the N-th set of limit-results.
`Orderby`	Desired order of returned collection set.
`Ids`	Comma-separated list of collection ids. Will return the collection for each existing collection.
`Count`	Indicates whether or not the response should include count results.
`Keyword`	Search on matching names.
`Ispublic`	Indicates whether or not the return should only contain collections marked as public. When left unspecified, no filtering happens.
`Mincount`	Minimum amount of assets that the returned collections should have.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/{id}/

Retrieve details of a specific collection by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/{id}/media/

Retrieve the assets associated with a specific collection.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Deleteids`	A comma-separated list of asset IDs to remove from the collection before adding new ones.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/collections/{id}/share/

Warning: Requires the SHARECOLLECTION or SHARING security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Collection id.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Recipients`	Comma-separated email addresses of recipients. Mandatory if groups or profiles are empty.
`Groups`	Comma-separated list of group ids. Mandatory if recipients or profiles are empty.
`Profiles`	Comma-separated list of profile ids. Mandatory if recipients or groups are empty.
`Collectionoptions`	Recipient rights.
`Loginrequired`	Should recipients login to view the collection. Mandatory if collectionOptions is edit.
`Datestart`	Start date of the share.
`Dateend`	End date of the share.
`Sendmail`	Wether the recipients should be notified using an e-mail.
`Message`	If sendMail is set to true, this is an optional message to be added for the recipient(s).

/api/v4/media/{id}/download/

Warning: Requires the MEDIAHIGHRES security role.

Warning: Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.

Warning: Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.

Warning: Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id.
`Type`	Type of files to download. Note that when multiple additional files are available only the download url of the latest one will be returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/{id}/{version}/download/

Get the download URL for a specific version of an asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id.
`Version`	Asset version to download.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/{id}/download/{itemId}/

Get the download URL for a specific item within an asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the asset you’d like to download a item of.
`Itemid`	The id of the specific asset item you’d like to download.
`Hash`	Indicates whether or not to treat the itemId as a hashed item id.
`Response Type`	The response format expected from the API (e.g. application/json).

/transform/{id}/{name}

Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it.
More information about this feature can be found in our Knowledge Base item.

Image operations can be passed as io parameters in the form of transform:{operation},{param1}:{value1},{param2}:{value2},....
It's possible to specify several operations: ?io={operation1}&io={operation2}&.... The operations will be applied in the same order they are passed in the url.

These are the possible image operations and their parameters:

Operation	Parameter	Possible values
`background`	color	color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)
`crop`	width	integer
	height	integer
	x	integer
	y	integer
	gravity	topleft / top / topright / left / center / right / bottomleft / bottom / bottomright
	shape	circle / square
	blur	integer
	background	color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)
`extend`	width	integer
	height	integer
	background	color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)
`fill`	width	integer
	height	integer
	gravity	topleft / top / topright / left / center / right / bottomleft / bottom / bottomright
	aspectratio	{integer}x{integer}
`fit`	width	integer
	height	integer
`flip`	(no parameters)
`mirror`	(no parameters)
`rotate`	angle	integer between 0 and 360
	background	color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)
`scale`	width	integer
	height	integer

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Io`	The operation(s) performed on the image before it's served to the client. It's possible to specify this parameter several times to have several operations applied.
`Focuspoint`	Focus point as a x,y coordinate (with values between 0 - 1). This will serve as the center point for the image operations.
`Format`	Format of the served image. This can either be jpg or png and it will overwrite the default webP.
`Quality`	Image quality, ranging from 1 - 100 (has no effect when format is set to 'png').
`Id`	The ID of the asset to transform.
`Name`	The name of the transformation to apply.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/groups/list/

Warning: Requires the GROUPMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Search Term`	Search on matching group names.
`Page`	What page of results to return.
`Limit`	Maximum results to return. If limit is not provided the first 20 resulsts will be returned.
`Sort Order`	Order of the returned list of groups.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/dependencies/{dependencyId}/

Warning: Specific metaproperty dependency operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty to which you’d like to add a dependency.
`Dependencyid`	Id of the (Metaproperty) option you'd like to become a dependency.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Count`	Include the total count of metaproperties in the response.
`Type`	Specify the metaproperty type (e.g., text, date).
`Options`	Provide options for the metaproperty.
`Ids`	Filter by metaproperty IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty to which you’d like to add a option.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/dependencies/{dependencyId}/

Warning: Specific metaproperty dependency operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty from which you’d like to delete a dependency.
`Dependencyid`	Id of the (Metaproperty) option you'd like to no longer be a dependency.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Data`	Include additional data in the response.
`Count`	Include the total count of metaproperties.
`Type`	Specify the type of metaproperty to delete.
`Options`	Provide options for the deletion.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/

Warning: Specific metaproperty option operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option which you’d like to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Data`	Include additional data in the response.
`Count`	Include the total count of metaproperties.
`Type`	Specify the type of metaproperty to modify.
`Options`	Provide options for the metaproperty.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/

Warning: Specific metaproperty option operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option which you’d like to modify.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/

Retrieve a list of all metaproperties.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Count`	Indicates whether or not the response should include asset count results for metaproperty-options.
`Type`	Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1.
`Options`	Indicates whether or not the response should include the metaproperty options of each metaproperty.
`Ids`	Comma-separated list of metaproperty ids. Will return a metaproperty for each existing id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/dependencies/

When a metaproperty has dependencies, the metaproperty won't be visble until a linked option is selected in the upload/bulk edit.
This call returns a list of depending meteproperty option ids.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Response Type`	The response format expected from the API (e.g. application/json).

/v4/metaproperties/{id}/options/

Retrieve the options for a specific metaproperty.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	Metaproperty option name.
`Limit`	Maximum number of results.Maximum: 1000.
`Page`	Offset page for results: return the N-th set of limit-results.
`Id`	The ID of the metaproperty whose options to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/v4/metaproperties/options/

Retrieve metaproperty options filtered by provided IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	Comma-separated list of metaproperty-option ids.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/

Retrieve details of a specific metaproperty by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Count`	Indicates whether or not the response should include asset count results for metaproperty-options.
`Type`	Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1.
`Options`	Indicates whether or not the response should include the metaproperty options of the metaproperty.
`Data`	Include additional data in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/{dependencyId}/

Add a dependency between metaproperty options.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the option belongs to.
`Optionid`	The id of the (metaproperty) option to which you’d like to add a dependency.
`Dependencyid`	The id of the (metaproperty) option you’d like to become a dependency.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/{dependencyId}/

Add a dependency option to an existing dependency group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option the dependency group belongs to.
`Groupid`	The id of the dependency group you’d like to add a dependency to.
`Dependencyid`	The id of the dependency (metaproperty option) you’d like to add to the dependency group.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/

Create a new dependency group for metaproperty options.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option for which you’d like to create a dependency group.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	JSON-serialised list of dependency option ids.

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/{dependencyId}/

Delete a specific dependency between metaproperty options.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the option belongs to.
`Optionid`	The id of the (metaproperty) option from which you’d like to delete a dependency.
`Dependencyid`	The id of the (metaproperty) option you’d like to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/

Delete a specific dependency group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option the dependency group belongs to.
`Groupid`	The id of the dependency group you’d like to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/

Modify an existing dependency group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option the dependency group belongs to.
`Groupid`	The id of the dependency group you’d like to modify.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	JSON-serialised string of dependency (metaproperty option) ids.

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/{dependencyId}/

Remove a dependency option from a dependency group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the metaproperty the (metaproperty) option belongs to.
`Optionid`	The id of the (metaproperty) option the dependency group belongs to.
`Groupid`	The id of the dependency group you’d like to remove a dependency from.
`Dependencyid`	The id of the dependency (metaproperty option) you’d like to remove from the dependency group.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/options/dependencies/

Retrieve all global option dependencies across metaproperties.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/dependencies/

Retrieve the dependencies defined for all options of a specific metaproperty. Use this action to see which option selections depend on others within a metaproperty.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/metaproperties/{id}/options/{optionId}/dependencies/

Retrieve the dependencies defined for a specific option of a metaproperty. Use this action to see which other options depend on the given option.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Optionid`	Metaproperty option id.
`Includegroupedresults`	Use grouped results like other option dependency calls.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/oauth/authorise/

During this step the user has to authorise & authenticate the request token pair. This request should be executed in a webview or browser where the user has to login to the Bynder portal. No authorization header is needed for this request.

Warning: Make sure you understand that the permissions of the temporary access token pair that will be created afterwards, will be bound to the user that was used to login.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Oauth Token`	The value of the request token provided by the 1st step.
`Callback`	A callback URL to be redirected to once the external portal login has been completed. If this parameter is missing then the auth_token is returned.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/oauth/access_token

In the final step, you exchange the request token pair for a temporary access token pair. This requires a fully signed OAuth request.
You use the oauth_token and oauth_token_secret with the values provided by the response of the 1st request. If successful the request token pair is immediately expired.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/oauth/request_token

The first step is obtaining a request token pair. A request token pair is only valid for 10 minutes and it will be used in the last step for obtaining the temporary access token pair.
This requires a valid signed OAuth request with only the Consumer Key and Secret.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v6/authentication/oauth2/auth

When using the Authorization Code grant, redirect the user to the Authorize application endpoint. After the user
is authenticated and approves the authorization request, Bynder will redirect the user back with an
authorization code which can then be passed to the Token endpoint.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	The client ID provided for the OAuth application.
`Scope`	Scopes to request authorization for. These must be separated by a space. Include offline to get a Refresh Token.
`Redirect Uri`	The URL for the authorize response redirect. This must exactly match one of the "Authorization redirect URIs" values specified for the OAuth application.
`Response Type`	Determines the grant being used. Only code is supported for the Authorization Code grant.
`State`	A random string used to maintain state between the request and callback. This value must is used to prevent CSRF attacks.
`Origin`	Optional origin header value to include in the request, typically the application's redirect URI origin.
`Response Type`	The response format expected from the API (e.g. application/json).

/v6/authentication/oauth2/scopes

The scopes endpoint provides a JSON formatted overview of the existing
scopes within Bynder and what user permissions are required in order
for the OAuth2 service to grant a scope to a user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/v6/authentication/oauth2/token

Use the token endpoint to retrieve a access token which can be used to authorize API
requests. Depending on the type of grant, different fields are required which are
outlined per request.

_The token endpoint requires authorization either in the body or by
sending the Authorization header._

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Origin`	Optional origin header value to include in the request, typically the application's redirect URI origin.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Client Id`	Application client ID.
`Client Secret`	Application client secret.
`Grant Type`	Identifies the grant type being used. For Authorization Code grant use authorization_code.
`Redirect Uri`	The URL specified in the Authorize application request, the values must match.
`Code`	The Authorization Code returned from the Authorize application request.
`Scope`	List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.

/api/pim/metapropertyoptions/{id}/

Warning: Currently you can only edit the children of a metaproperty option.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty option id.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Children`	A list of id's of the metaproperty options to be related as the metaproperty option's children. All current children will be overwritten.

/api/pim/metaproperties

Warning: Requires the metaproperty.view security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/pim/metaproperties/{id}/options/

Retrieves a paginated list of options for the given metaproperty id and these options' sub options.Warning: Requires the METAPROPERTYMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Order`	Order of the options, based on the option z-index and option name.
`Page`	Index to load a specific set of metaproperty options.
`Limit`	Amount of options that are retrieved per page.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/pim/metaproperties/{id}/

Retrieve the metaproperty details and it's metaproperty options.Warning: Requires the METAPROPERTYMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Metaproperty id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/profiles/

To determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the Retrieve specific user or Retrieve current user call.

It’s the API’s responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.Warning: Requires the PERMISSIONMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/profiles/{id}/

This call allows you to retrieve your own security profile without requiring the PERMISSIONMANAGEMENT security role.

In order to get your own security profile use your user profile id retrieved by executing the Specific User or Current User call.Warning: Requires the PERMISSIONMANAGEMENT security role if not retrieving your own security profile.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Security profile id.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/smartfilters/

Retrieve a list of all smartfilters configured in the Bynder portal. Use this action to fetch available smartfilters for filtering assets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/tags/{id}/media/

Warning: Tag operations on assets require the MEDIAEDIT or MEDIAAUDIT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Tag id.
`Deleteids`	A comma-separated list of asset IDs to remove from the collection before adding new ones.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	JSON-serialised list of asset ids to which you'd like to add the tag.

/api/v4/tags/{id}/media/

Warning: Tag operations on assets require the MEDIAEDIT or MEDIAAUDIT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Tag id.
`Deleteids`	Comma-separated asset ids from which to remove the tag.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/tags/

Retrieve a list of all tags used in the Bynder portal. Use this action to get the complete tag set for filtering or categorizing assets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	Maximum number of results.Maximum: 1000.
`Page`	Offset page for results: return the N-th set of limit-results.
`Orderby`	Order of the returned list of tags.
`Keyword`	Search on matching names.
`Mincount`	Minimum media count that the returned tags should have.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/trash/media/

Warning: You can only retrieve the removed assets from the last 30 days.

Warning: Requires the trash.assets security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Limit`	Maximum number of results.
`Page`	Offset page for results: return the N-th set of limit-results.
`Dateremoved`	Retrieve assets removed after this date.Format: yyyy-mm-dd hh:mm:ss
`Field`	Field to sort on the returned list of assets.
`Order`	Sort order of returned list of assets. Sorts the list of assets by the field parameter defined, if the field parameter was not defined the results will be sorted by media.name.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/{id}/save/additional/{uploadId}/

Warning: This call should only be used if you are uploading an additional file for an asset, if you are not go to step 5.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id to which to save the new additional.
`Uploadid`	The upload id of the file.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Targetid`	Target id as returned by the initialise call.
`S3 Filename`	Base location of the uploaded file.
`Chunks`	Total number of chunks uploaded.

/api/upload/endpoint

Retrieve the Amazon S3 endpoint URL closest to the caller's geographic location. Use this action before initializing an upload to ensure optimal transfer speed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/upload/init

Initialize an upload session by requesting upload parameters from Bynder. Use this action to start the upload process and receive the necessary upload URL and fields.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Filename`	Filename of new upload (extension required).

/api/v4/upload/{id}/

Uploading a file consists of:

Breaking down your file in parts/chunks. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

For more information, about how amazon handles parts/chunks, visit: Amazon's website.

Sending the chunks over to Amazon and then registering them to Bynder. You can repeat those calls up until your file has been uploaded completely.

1. Upload a chunk

Make a POST request to the Amazon upload endpoint you received from calling Get closest AmazonS3 upload endpoint.
Use a multipart/form-data to send all of the parameters that the multipart_params of the previous request included; plus the following additional parameters:

Name	Value	Type
`Content-Type`	Content type extracted from the `multipart_params`'s `Content-Type` of the response of the initialise upload request.	string
`Policy`	Policy extracted from the `multipart_params`'s `Policy` of the response of the initialise upload request.	string
`X-Amz-Signature`	Signature extracted from the `multipart_params`'s `X-Amz-Signature` of the response of the initialise upload request.	string
`acl`	Access control list extracted from the `multipart_params`'s `acl` of the response of the initialise upload request.	string
`key`	Key extracted from the `multipart_params`'s `key` of the response of the initialise upload request followed by p{Chunk index number}. Example: "pluploads/12345/image.png/p1".	string
`success_action_status`	Success action status extracted from the `multipart_params`'s `success_action_status` of the response of the initialise upload request.	string
`x-amz-algorithm`	Algorithm extracted from the `multipart_params`'s `x-amz-algorithm` of the response of the initialise upload request.	string
`x-amz-credential`	Credential extracted from the `multipart_params`'s `x-amz-credential` of the response of the initialise upload request.	string
`x-amz-date`	Date extracted from the `multipart_params`'s `x-amz-date` of the response of the initialise upload request.	string
`name`	Filename that was passed as attribute in the initialise upload request.	string
`chunk`	Chunk index number (indexing starts from 1).	number
`chunks`	Total number of chunks.	number
`Filename`	The value of the `key` from the `multipart_params` of the response of the initise upload request followed by p{Chunk index number}. Example: "pluploads/12345/image.png/p1". ATTENTION: `Filename` must start with capital `F`.	string
`file`	File or chunk of the file to be uploaded.	byte array

2. Register uploaded chunk

After uploading a chunk, you must register it's completion to Bynder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Upload id for the uploaded file.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Chunknumber`	Number of the chunk that was uploaded.
`Targetid`	The targetid that was returned by the initialise call.
`Filename`	Location of the uploaded chunk.

/api/v4/upload/poll/

Warning: This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the items parameter.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Items`	Comma-separated import id's of a finalised file, as returned by the finalise call.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/media/save/{importId}/

Save the uploaded file as a new asset in Bynder. Use this action after the file has been uploaded to S3, providing the import ID from the initialization step.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Importid`	Import id of a finalised and processed upload to be saved.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Brandid`	Brand id to save the asset to.
`Name`	Name of the asset. Warning: The asset will have no name if this is left empty.
`Description`	Description of the asset.
`Copyright`	Copyright information of the asset.
`Tags`	Comma-separated list of tags of the asset.
`Metaproperty`	Dictionary with (metaproperty) options to set on the asset. Send fields as metaproperty.METAPROPERY_ID with a string of all its (metaproperty) options ids comma-separated. Warning: The list of (metaproperty) options ids should include all the (metaproperty) options ids available in the lower hierarchy; meaning it should include the (metaproperty) options of the (metaproperty) options etc.
`Categories`	Comma-separated category ids of the asset.
`Audit`	Flags if the asset should be sent to the waiting room. Warning: In order to be able to chose whether or not the asset will be uploaded to the waiting room you'll need both the MEDIAUPLOAD and MEDIAUPLOADFORAPPROVAL security role.
`Ispublic`	Flags if the asset should be Public.
`Accessrequestid`	If audit is set to true you can specify an accessRequestId to batch uploads to the waiting room. The accessRequestId is retrieved in the response of this endpoint, after you save the first asset of your batch.
`Requestorid`	If audit is set to true you can specify a requestor ID (user ID) to identify the user uploading the asset to the waiting room.
`Accesstype`	If audit is set to true you can specify an access type to define to which waiting room location the asset is uploaded to. The available locations are: Upload, Edit, Workflow approval (export), Shutterstock and Stock.
`Isopublicationdate`	Date/time of publication in ISO08601-format.
`Publicationdate`	DEPRECATED Date/time of publication in linked API user selected locale-format.
`Archivedate`	Archive date/time of the asset in ISO8601-format.
`Watermarkdate`	Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
`Crc32`	CRC32 checksum of the original file, used for verification.

/api/v4/media/{id}/save/{importId}/

Save the uploaded file as a new version of an existing asset. Use this action to replace a previous asset version, providing the asset ID and the import ID from the upload initialization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	Asset id for which to save the new version.
`Importid`	Import id of a finalised and processed upload to be saved.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/users/

Warning: User operations require the USERMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includeinactive`	Optional flag indicating whether to include inactive users in the response; pass "true" to include inactive users.
`Limit`	Limit the number of results returned.
`Page`	Specify the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (15)

Option Name	Description
`Username`	Username for login. If not defined it will take your email as username.
`Password`	Password for login.
`Email`	Email address.
`Profileid`	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.
`Active`	Whether or not the user will be active, inactive users won't be able to login.
`Language`	Prefered website language, options can be retrieved using the Retrieve account call.
`Firstname`	First name.
`Infix`	Infix.
`Lastname`	Last name.
`Groupids`	A list of group ids to which the user will be added. Can be retrieved by using Retrieve groups call. Requires GROUPMANAGEMENT security role.
`Phonenumber`	Phone number.
`Companyname`	Company name.
`Department`	Company department.
`Job`	Job description.
`Costcenter`	Company cost centre.

/api/v4/users/{id}/

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id or username of the user you’d like to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/users/{id}/

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of the user you’d like to modify.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (16)

Option Name	Description
`Username`	Username.
`Password`	Password for login.
`Email`	Email address.
`Profileid`	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.
`Active`	Whether or not the user will be active, inactive users won't be able to login.
`Language`	Prefered website language, options can be retrieved using the Retrieve account call.
`Firstname`	First name.
`Infix`	Infix.
`Lastname`	Last name.
`Groupids`	A list of group ids to which the user will be added. Can be retrieved by using Retrieve groups call. Requires GROUPMANAGEMENT security role.
`Phonenumber`	Phone number.
`Companyname`	Company name.
`Department`	Company department.
`Job`	Job description.
`Costcenter`	Company cost centre.
`Termsaccepted`	Indicates whether or not the user has accepted the login terms & conditions.

/api/v4/currentUser/

Retrieve the current user information. Unlike Retrieve specific user this call doesn't require you to know your user id in order to retrieve your current user information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/users/{id}/

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id or username of the user you’d like to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/v4/users/

Warning: User operations require the USERMANAGEMENT security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includeinactive`	Whether to include inactive users in the list of results.
`Limit`	Maximum results to return. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers.
`Page`	What page of results to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/campaigns/

Warning: Requires the CAMPAIGNADD security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Name`	Name of the campaign
`Key`	4 character key representing the campaign
`Description`	Description of the campaign
`Datestart`	Date of when the campaign starts
`Deadline`	Date of when the campaign ends
`Closed`	Status of Campaign open active/closed
`Responsibleid`	Id of the user responsible for the campaign
`Campaignmetaproperties`	Campaign Metaproperties

/api/workflow/campaigns/{id}/

Warning: Requires the CAMPAIGNREMOVE security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Campaign.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/campaigns/{id}/

Warning: Requires the CAMPAIGNEDIT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Campaign.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Name`	Name of the campaign
`Key`	4 character key representing the campaign
`Description`	Description of the campaign
`Datestart`	Date of when the campaign starts
`Deadline`	Date of when the campaign ends
`Closed`	Status of Campaign open active/closed
`Responsibleid`	Id of the user responsible for the campaign
`Campaignmetaproperties`	Campaign Metaproperties

/api/workflow/campaigns/

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/campaigns/{id}/

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Campaign.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/groups/

Create a new workflow group in the Bynder workflow system. Use this action to define a group that can be assigned to workflow jobs.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/groups/{id}/

Permanently delete a specific workflow group by its ID. Use this action to remove a group that is no longer needed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Workflow group.
`Content-type`	The content type of the request body, if needed.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/groups/{id}/

Update the details of an existing workflow group. Use this action to change group name or other properties.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Workflow group.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/groups/

Retrieve a list of all workflow groups. Use this action to get the available groups for assignment to workflow jobs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/groups/{id}/

Retrieve the details of a single workflow group by its ID. Use this action to get information about a specific group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Workflow group.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/jobs/

Warning: Requires the JOBADD security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Datecreatedfrom`	Optional start date for filtering jobs by creation date, in ISO 8601 format.
`Datecreatedto`	Optional end date for filtering jobs by creation date.
`Datemodifiedfrom`	Optional start date for filtering jobs by modification date.
`Datemodifiedto`	Optional end date for filtering jobs by modification date.
`Deadlinefrom`	Optional start date for filtering jobs by deadline.
`Deadlineto`	Optional end date for filtering jobs by deadline.
`Orderby`	Define the order in which results are sorted.
`Limit`	Limit the number of results returned.
`Page`	Specify the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Name`	Name of the job
`Description`	Description of the job
`Deadline`	Date of when the job ends
`Campaignid`	Id of the campaign the job is part of
`Accountableid`	Id of the user responsible for the job
`Presetid`	Id of the preset the job should be created from
`Jobmetaproperties`	ID and metaproperty values

/api/workflow/jobs/{id}/

Warning: Requires the JOBREMOVE security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Job.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/jobs/{id}/

Warning: Requires the JOBEDIT security role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Job.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	Name of the job
`Description`	Description of the job
`Deadline`	Date of when the job ends
`Campaignid`	Id of the campaign the job is part of
`Accountableid`	Id of the user responsible for the job
`Jobmetaproperties`	ID and metaproperty values

/api/workflow/jobs/

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Datecreatedfrom`	Only return jobs which have a dateCreated on or after this datetime.
`Datecreatedto`	Only return jobs which have a dateCreated before or on this datetime.
`Datemodifiedfrom`	Only return jobs which have a dateModified on or after this datetime.
`Datemodifiedto`	Only return jobs which have a dateModified before or on this datetime.
`Deadlinefrom`	Only return jobs which have a deadline on or after this datetime.
`Deadlineto`	Only return jobs which have a deadline before or on this datetime.
`Resonsibleids`	Comma-separated list of workflow user IDs or workflow user group IDs.
`Accountableids`	Comma-separated list of workflow user IDs.
`Status`	Comma-separated list of job status.
`Orderby`	Field to order results by
`Limit`	Maximum results to return, maximum: 1000. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers.
`Page`	What page of results to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/jobs/{id}/media/

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Job.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/jobs/{id}/

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Job.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/presets/job/{id}/

Warning: Requires the PRESETOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Job Preset.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/campaigns/{id}/jobs/

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a Campaign.
`Datecreatedfrom`	Only return jobs which have a dateCreated on or after this datetime.
`Datecreatedto`	Only return jobs which have a dateCreated before or on this datetime.
`Datemodifiedfrom`	Only return jobs which have a dateModified on or after this datetime.
`Datemodifiedto`	Only return jobs which have a dateModified before or on this datetime.
`Deadlinefrom`	Only return jobs which have a deadline on or after this datetime.
`Deadlineto`	Only return jobs which have a deadline before or on this datetime.
`Resonsibleids`	Comma-separated list of workflow user IDs or workflow user group IDs.
`Accountableids`	Comma-separated list of workflow user IDs.
`Status`	Comma-separated list of job status.
`Orderby`	Field to order results by
`Limit`	Maximum results to return, maximum: 1000. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers.
`Page`	What page of results to return.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/metaproperties/

Retrieve a list of all workflow metaproperties. Use this action to get the custom fields available for workflow jobs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/metaproperties/{id}

Retrieve the details of a single workflow metaproperty by its ID. Use this action to get information about a specific custom field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The id of a metaproperty.
`Response Type`	The response format expected from the API (e.g. application/json).

/api/workflow/users/

Retrieve a list of all users in the workflow system. Use this action to get available users for assignment to workflow jobs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Access rights (3)

Account (2)

Analytics (18)

Asset usage (4)

Assets (6)

Brands

Brandstore (7)

Collections (9)

Download (3)

Dynamic Asset Transformations

Groups

Metaproperties (13)

Metaproperty option dependencies (10)

OAuth 1.0a (3)

OAuth 2.0 (3)

Product layer metaproperties (4)

Security roles (2)

Smartfilters

Tags (3)

Trash

Upload assets (7)

1. Upload a chunk

2. Register uploaded chunk

Users (6)

Workflow campaigns (5)

Workflow groups (5)

Workflow jobs (8)

Workflow metaproperties (2)

Workflow users