Breadcrumbs

Bynder Connector v1.0 R4

Version 1 Revision 4

Connector Overview: This page documents all 129 endpoints for the Bynderconnector v1 R4.

View API Documentation


POST

Access rights: Create metaproperty access

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Metaproperty Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Level

Field to fetch specific permissions


DELETE

Access rights: Delete metaproperty access

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Metaproperty Id

N/A

Response Type

N/A


GET

Access rights: Retrieve metaproperty access

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Metaproperty Id

N/A

Response Type

N/A


GET

Account: Retrieve account information

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Account: Retrieve 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Analytics: Asset Activity

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Activity CSV

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Archive

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Archive CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Create

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Create CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Download

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Download CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Remove

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset Remove CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset View

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Asset View CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Search Keyword

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: Search Keyword CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: User Activity

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: User Activity CSV

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: User Login

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Analytics: User Login CSV

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Asset usage: Create asset 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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Asset Id

N/A

Integration Id

N/A

Uri

N/A

Response Type

N/A

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.


DELETE

Asset usage: Delete asset 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Integration Id

Integration id.

Asset Id

Asset id.

Uri

Asset location.

Response Type

N/A


GET

Asset usage: Retrieve asset 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Asset Id

Asset id.

Integration Id

Integration id.

Uri

URI.

Response Type

N/A


POST

Asset usage: Sync asset usage

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

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

N/A


POST

Assets: Add metaproperty 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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

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.


DELETE

Assets: Delete asset

Warning: Requires the MEDIAREMOVE security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id.

Versions

N/A

Stats

N/A

Response Type

N/A


DELETE

Assets: Delete metaproperty 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content-type

N/A

Response Type

N/A


POST

Assets: Modify asset

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id.

Versions

N/A

Stats

N/A

Response Type

N/A

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.


GET

Assets: Retrieve assets

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Assets: Retrieve specific asset

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id.

Versions

Include information about the different asset media items including versions.

Stats

Include information about views and downloads.

Response Type

N/A


GET

Brands: Retrieve brands

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


POST

Brandstore: Modify order

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Order id.

Response Type

N/A

Options (3)

Option Name

Description

Status

New status of the order.

Message

Message

Trackingnumber

Link to trackingnumber


PATCH

Brandstore: Modify orderline

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Orderline id.

Response Type

N/A


GET

Brandstore: Retrieve orders

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Page

Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10.

Response Type

N/A


GET

Brandstore: Retrieve specific order by id

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Order id.

Response Type

N/A


GET

Brandstore: Retrieve specific order by number

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ordernumber

The order number without the country code (NA13334).

Response Type

N/A


GET

Brandstore: Retrieve specific order info

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Order id.

Response Type

N/A


GET

Brandstore: Retrieve specific orderline

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Orderline id.

Response Type

N/A


POST

Collections: Add assets to a collection

Warning: Requires the COLLECTIONS security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Deleteids

N/A

Response Type

N/A

Options (1)

Option Name

Description

Data

JSON-serialised list of asset ids to add.


POST

Collections: Create collection

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

N/A

Page

N/A

Orderby

N/A

Ids

N/A

Count

N/A

Keyword

N/A

Ispublic

N/A

Mincount

N/A

Response Type

N/A

Options (2)

Option Name

Description

Name

Collection name.

Description

Collection description.


DELETE

Collections: Delete collection

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id to be deleted.

Content-type

N/A

Response Type

N/A


POST

Collections: Modify collection

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Response Type

N/A

Options (3)

Option Name

Description

Name

Collection name.

Description

Collection description.

Ispublic

Public state of the collection.


DELETE

Collections: Remove assets from a collection

Warning: Requires the COLLECTIONS security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Deleteids

Comma-separated asset ids to remove from the collection.

Response Type

N/A


GET

Collections: Retrieve 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Collections: Retrieve specific collection

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Response Type

N/A


GET

Collections: Retrieve the assets of a specific collection

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Deleteids

N/A

Response Type

N/A


POST

Collections: Share collection

Warning: Requires the SHARECOLLECTION or SHARING security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Collection id.

Response Type

N/A

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).


GET

Download: Retrieve asset download location

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Download: Retrieve asset version download location

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id.

Version

Asset version to download.

Response Type

N/A


GET

Download: Retrieve specific asset item download location

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Dynamic Asset Transformations: Generate dynamic asset transformation

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Name

N/A

Response Type

N/A


GET

Groups: Retrieve groups

Warning: Requires the GROUPMANAGEMENT security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Metaproperties: Create dependency

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Response Type

N/A


POST

Metaproperties: Create metaproperty

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Count

N/A

Type

N/A

Options

N/A

Ids

N/A

Response Type

N/A


POST

Metaproperties: Create metaproperty option

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of the metaproperty to which you’d like to add a option.

Response Type

N/A


DELETE

Metaproperties: Delete dependency

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


DELETE

Metaproperties: Delete metaproperty

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Data

N/A

Count

N/A

Type

N/A

Options

N/A

Response Type

N/A


DELETE

Metaproperties: Delete metaproperty option

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Metaproperties: Modify metaproperty

Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Data

N/A

Count

N/A

Type

N/A

Options

N/A

Response Type

N/A


POST

Metaproperties: Modify metaproperty option

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Metaproperties: Retrieve metaproperties

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Metaproperties: Retrieve metaproperty 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Response Type

N/A


GET

Metaproperties: Retrieve metaproperty options

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Response Type

N/A


GET

Metaproperties: Retrieve metaproperty options by ids

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

Comma-separated list of metaproperty-option ids.

Response Type

N/A


GET

Metaproperties: Retrieve specific metaproperty

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Response Type

N/A


POST

Metaproperty option dependencies: Add a dependency

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Metaproperty option dependencies: Add a dependency option to a group

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Response Type

N/A


POST

Metaproperty option dependencies: Create dependency group

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Options (1)

Option Name

Description

Data

JSON-serialised list of dependency option ids.


DELETE

Metaproperty option dependencies: Delete a dependency

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


DELETE

Metaproperty option dependencies: Delete dependency group

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Metaproperty option dependencies: Modify dependency group

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Options (1)

Option Name

Description

Data

JSON-serialised string of dependency (metaproperty option) ids.


DELETE

Metaproperty option dependencies: Remove a dependency option from a group

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Metaproperty option dependencies: Retrieve global option dependencies

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Metaproperty option dependencies: Retrieve metaproperty option dependencies

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Response Type

N/A


GET

Metaproperty option dependencies: Retrieve specific metaproperty option dependencies

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Optionid

Metaproperty option id.

Includegroupedresults

Use grouped results like other option dependency calls.

Response Type

N/A


GET

OAuth 1.0a: Authorise & Authenticate

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

OAuth 1.0a: Exchange the request token pair for an access token pair

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


POST

OAuth 1.0a: Obtain a Request token pair

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

OAuth 2.0: Authorize application

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A

Response Type

N/A


GET

OAuth 2.0: Retrieve 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content-type

N/A

Response Type

N/A


POST

OAuth 2.0: Using an authorization code

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Origin

N/A

Response Type

N/A

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.


PUT

Product layer metaproperties: Modify metaproperty option

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty option id.

Response Type

N/A

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.


GET

Product layer metaproperties: Retrieve metaproperties

Warning: Requires the metaproperty.view security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Product layer metaproperties: Retrieve metaproperty 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Product layer metaproperties: Retrieve specific metaproperty

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Metaproperty id.

Response Type

N/A


GET

Security roles: Retrieve security 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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Security roles: Retrieve specific security profile

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Security profile id.

Response Type

N/A


GET

Smartfilters: Retrieve smartfilters

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


POST

Tags: Add tag to assets

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

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Tag id.

Deleteids

N/A

Response Type

N/A

Options (1)

Option Name

Description

Data

JSON-serialised list of asset ids to which you'd like to add the tag.


DELETE

Tags: Remove tag from assets

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Tag id.

Deleteids

Comma-separated asset ids from which to remove the tag.

Response Type

N/A


GET

Tags: Retrieve tags

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Trash: Retrieve recently removed assets

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Upload assets: Finalise a completely uploaded file and save as a new asset additional

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id to which to save the new additional.

Uploadid

The upload id of the file.

Response Type

N/A

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.


GET

Upload assets: Get closest AmazonS3 upload endpoint

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


POST

Upload assets: Initialise upload

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Options (1)

Option Name

Description

Filename

Filename of new upload (extension required).


POST

Upload assets: Register uploaded chunk

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

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Upload id for the uploaded file.

Response Type

N/A

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.


GET

Upload assets: Retrieve poll state

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Items

Comma-separated import id's of a finalised file, as returned by the finalise call.

Response Type

N/A


POST

Upload assets: Save as a new asset

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Importid

Import id of a finalised and processed upload to be saved.

Response Type

N/A

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.


POST

Upload assets: Save as a new asset version

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

Asset id for which to save the new version.

Importid

Import id of a finalised and processed upload to be saved.

Content-type

N/A

Response Type

N/A


POST

Users: Create user

Warning: User operations require the USERMANAGEMENT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Includeinactive

N/A

Limit

N/A

Page

N/A

Response Type

N/A

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.


DELETE

Users: Delete user

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id or username of the user you’d like to delete.

Response Type

N/A


POST

Users: Modify user

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of the user you’d like to modify.

Response Type

N/A

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.


GET

Users: Retrieve current user

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

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Users: Retrieve specific user

Warning: Specific user operations require the USERMANAGEMENT security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id or username of the user you’d like to retrieve.

Response Type

N/A


GET

Users: Retrieve users

Warning: User operations require the USERMANAGEMENT security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


POST

Workflow campaigns: Create campaign

Warning: Requires the CAMPAIGNADD security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

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


DELETE

Workflow campaigns: Delete campaign

Warning: Requires the CAMPAIGNREMOVE security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Campaign.

Response Type

N/A


PUT

Workflow campaigns: Modify campaign

Warning: Requires the CAMPAIGNEDIT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Campaign.

Response Type

N/A

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


GET

Workflow campaigns: Retrieve campaigns

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Workflow campaigns: Retrieve specific campaign

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Campaign.

Response Type

N/A


POST

Workflow groups: Create group

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


DELETE

Workflow groups: Delete group

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Workflow group.

Content-type

N/A

Response Type

N/A


PUT

Workflow groups: Modify group

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Workflow group.

Response Type

N/A


GET

Workflow groups: Retrieve groups

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Workflow groups: Retrieve specific group

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Workflow group.

Response Type

N/A


POST

Workflow jobs: Create job

Warning: Requires the JOBADD security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Datecreatedfrom

N/A

Datecreatedto

N/A

Datemodifiedfrom

N/A

Datemodifiedto

N/A

Deadlinefrom

N/A

Deadlineto

N/A

Orderby

N/A

Limit

N/A

Page

N/A

Response Type

N/A

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


DELETE

Workflow jobs: Delete job

Warning: Requires the JOBREMOVE security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Job.

Response Type

N/A


PUT

Workflow jobs: Modify job

Warning: Requires the JOBEDIT security role.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Job.

Response Type

N/A

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


GET

Workflow jobs: Retrieve jobs

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Workflow jobs: Retrieve media of specific job

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Job.

Response Type

N/A


GET

Workflow jobs: Retrieve specific job

Warning: Requires the JOBOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Job.

Response Type

N/A


GET

Workflow jobs: Retrieve specific job preset

Warning: Requires the PRESETOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a Job Preset.

Response Type

N/A


GET

Workflow jobs: Retrieve the jobs of a specific campaign

Warning: Requires the CAMPAIGNOVERVIEW security role.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

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

N/A


GET

Workflow metaproperties: Retrieve metaproperties

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A


GET

Workflow metaproperties: Retrieve specific metaproperty

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id of a metaproperty.

Response Type

N/A


GET

Workflow users: Retrieve users

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A