Bynder Component

Bynder is a leading digital asset management software that allows users to easily create, find, and use content, such as documents, graphics, and videos.

Component key: bynder

Description

Bynder is a leading digital asset management software that allows users to easily create, find, and use content, such as documents, graphics, and videos.

Use the Bynder component to manage Assets, Collections, Campaigns, and more.

API Documentation

The Bynder component is built using the Bynder April 2024 REST API

Connections

OAuth 2.0 Client Credentials

key: bynder-client-credentials-oauth

To create a new OAuth App for the Client Credentials flow:

Prerequisites

A Bynder account with administrator access to Portal Settings

Setup Steps

Sign into Bynder and navigate to Settings > Advanced Settings > Portal Settings and select OAuth Apps
Select Register new application to create an OAuth App
Set Grant Type to Client Credentials and configure the assigned user:
- Choose the user for which tokens will be issued. Enter the name of the user and click one of the returned search results. A dedicated user in the portal is recommended if one does not already exist.
Add at least the following scopes: asset:read asset:write collection:read collection:write
Select Register application to retrieve a Client ID and Client Secret

Configure the Connection

Create a connection of type OAuth 2.0 Client Credentials and enter:

Token URL: The Bynder token URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/token)
Scopes: The required OAuth scopes (defaults are pre-populated)
Client ID: The Client ID from the registered OAuth application
Client Secret: The Client Secret from the registered OAuth application

Input	Notes	Example
Client ID	The Client ID from the Bynder OAuth application credentials.	12345678-1234-1234-1234-123456789abc
Client Secret	The Client Secret from the Bynder OAuth application credentials.
Scopes	Space-separated list of OAuth permission scopes granted to the access token.	asset:read asset:write collection:read collection:write current.user:read current.profile:read workflow.campaign:read workflow.campaign:write workflow.job:read workflow.job:write brandstore.order:read brandstore.order:write meta.assetbank:read meta.assetbank:write admin.profile:read admin.user:read admin.user:write workflow.preset:read offline
Token URL	The OAuth 2.0 token URL used to exchange the client credentials for an access token.	https://portal.bynder.com/v6/authentication/oauth2/token

OAuth 2.0

key: bynder-oauth

To create a new OAuth App for the OAuth 2.0 Authorization Code flow:

Prerequisites

A Bynder account with administrator access to Portal Settings

Setup Steps

Sign into Bynder and navigate to Settings > Advanced Settings > Portal Settings and select OAuth Apps
Select Register new application to create an OAuth App
Set Grant Type to Authorization Code and configure the redirect URL:
- Set the redirect URI to https://oauth2.prismatic.io/callback
Add at least the following scopes: asset:read asset:write collection:read collection:write
Select Register application to retrieve a Client ID and Client Secret

Configure the Connection

Create a connection of type OAuth 2.0 and enter:

Authorize URL: The Bynder authorization URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/auth)
Token URL: The Bynder token URL (e.g., https://{your-bynder-domain}/v6/authentication/oauth2/token)
Scopes: The required OAuth scopes (defaults are pre-populated)
Client ID: The Client ID from the registered OAuth application
Client Secret: The Client Secret from the registered OAuth application

Input	Notes	Example
Authorize URL	The OAuth 2.0 authorization URL for the Bynder domain.	https://portal.bynder.com/v6/authentication/oauth2/auth
Client ID	The Client ID from the Bynder OAuth application credentials.	12345678-1234-1234-1234-123456789abc
Client Secret	The Client Secret from the Bynder OAuth application credentials.
Scopes	Space-separated list of OAuth permission scopes granted to the access token.	asset:read asset:write collection:read collection:write current.user:read current.profile:read workflow.campaign:read workflow.campaign:write workflow.job:read workflow.job:write brandstore.order:read brandstore.order:write meta.assetbank:read meta.assetbank:write admin.profile:read admin.user:read admin.user:write workflow.preset:read offline
Token URL	The OAuth 2.0 token URL used to exchange the authorization code for an access token.	https://portal.bynder.com/v6/authentication/oauth2/token

Data Sources

Select Asset

Select an asset from the list of assets available in Bynder. | key: selectAsset | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "D4E5F6A7-B8C9-0123-D4E5-F6A7B8C90123",
      "label": "Grassland (ID: D4E5F6A7-B8C9-0123-D4E5-F6A7B8C90123)"
    }
  ]
}

Select Brand

Select a brand from the list of brands available in Bynder. | key: selectBrand | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "A1B2C3D4-E5F6-7890-A1B2C3D4E5F67890",
      "label": "Bynder Brand Portal (ID: A1B2C3D4-E5F6-7890-A1B2C3D4E5F67890)"
    }
  ]
}

Select Campaign

Select a campaign from the list of campaigns available in Bynder. | key: selectCampaign | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "123",
      "label": "Campaign Name (ID: 123)"
    }
  ]
}

Select Collection

Select a collection from the list of collections available in Bynder. | key: selectCollection | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "123",
      "label": "Collection Name (ID: 123)"
    }
  ]
}

Select Job

Select a job from the list of jobs available in Bynder. | key: selectJob | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "123",
      "label": "Job Name (ID: 123)"
    }
  ]
}

Select Metaproperty

Select a metaproperty from the list of metaproperties available in Bynder. | key: selectMetaproperty | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "label": "Colours (ID: 123)",
      "key": "123"
    }
  ]
}

Select Order

Select an order from the list of orders available in Bynder. | key: selectOrder | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "A1B2C3D4-E5F6-7890-A1B2-C3D4E5F67890",
      "label": "NA13334 (ID: A1B2C3D4-E5F6-7890-A1B2-C3D4E5F67890)"
    }
  ]
}

Select Security Profile

Select a security profile from the list of profiles available in Bynder. | key: selectSecurityProfile | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "label": "Internal Limited user (ID: 123)",
      "key": "123"
    }
  ]
}

Select User

Select a user from the list of users available in Bynder. | key: selectUser | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "A1B2C3D4-E5F6-7890-A1B2-C3D4E5F67890",
      "label": "David (ID: A1B2C3D4-E5F6-7890-A1B2-C3D4E5F67890)"
    }
  ]
}

Actions

Add Asset Metaproperty Options

Add metaproperty options to an asset | key: addAssetMetapropertyOptions

Input	Notes	Example
Asset ID	Id of the asset.	00000000-0000-0000-0000000000000000
Connection
Metaproperty ID	Id of the metaproperty from which you want to add options.	00000000-0000-0000-0000000000000000
Metaproperty Options IDs	List of metaproperty option ids you want to add to the asset.	00000000-0000-0000-0000000000000000

{
  "data": {
    "message": "Created",
    "statuscode": 201
  }
}

Close Campaign

Delete an existing campaign | key: closeCampaign

Input	Notes	Example
Connection
Campaign ID	The ID of the campaign to delete	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Create Campaign

Create a new campaign | key: createCampaign

Input	Notes	Example
Data	Additional data to update the campaign
Connection
Description	The description of the campaign	Extended asset description
Key	4 character key representing the campaign	excp
Name	The name of the campaign	Asset Name
Responsible ID	Id of the user responsible for the campaign	00000000-0000-0000-0000-000000000000

{
  "data": {
    "name": "Example campaign",
    "key": "excp",
    "description": "Campaign example",
    "dateStart": "2015-01-01T00:00:00",
    "deadline": "2015-09-04T00:00:00",
    "responsibleID": "00000000-0000-0000-0000-000000000000",
    "campaignMetaproperties": "00000000-0000-0000-0000-000000000000"
  }
}

Create Collection

Create a new collection | key: createCollection

Input	Notes	Example
Connection
Collection Description	The description of the collection to create	Extended asset description
Collection Name	The name of the collection to create	Asset Name

{
  "data": {
    "message": "Created",
    "statuscode": 201
  }
}

Create Job

Create a new job | key: createJob

Input	Notes	Example
Accountable ID	Id of the user responsible for the job	00000000-0000-0000-0000000000000000
Data	Additional data to create the job
Campaign ID	Id of the campaign the job is part of	00000000-0000-0000-0000000000000000
Connection
Description	The description of the job	Extended asset description
Name	The name of the job	Asset Name
Preset ID	Id of the preset the job should be created from	00000000-0000-0000-0000000000000000

{
  "data": {
    "name": "Job Example",
    "description": "Job Description",
    "deadline": "2018-09-29",
    "campaignID": "00000000-0000-0000-0000-000000000000",
    "accountableID": "00000000-0000-0000-0000-000000000000",
    "presetID": "00000000-0000-0000-0000-000000000000",
    "jobMetaproperties": {
      "00000000-0000-0000-0000-000000000000": "00000000-0000-0000-0000-000000000000"
    },
    "stages": [
      {
        "description": "Awesome description",
        "preset_stage_id": "00000000-0000-0000-0000-000000000000",
        "name": "Review ",
        "responsibleID": "00000000-0000-0000-0000-000000000000",
        "deadline": "2018-09-29"
      },
      {
        "description": "Stage description",
        "preset_stage_id": "00000000-0000-0000-0000-000000000000",
        "name": "Approval",
        "responsibleGroupID": "00000000-0000-0000-0000-000000000000",
        "deadline": "2018-09-29"
      }
    ]
  }
}

Create User

Create a new user | key: createUser

Input	Notes	Example
Data	Extra fields to be included in the request. Must be valid JSON.
Connection
Email	Email address for login.	test@test.com
First Name	First name of the user.	John
Last Name	Last name of the user.	Doe
Password	Password for login.	password
Profile ID	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.	00000000-0000-0000-0000000000000000
Username	Username for login. If not defined it will take your email as username.	user123

{
  "data": {
    "id": "00000000-0000-0000-0000000000000000",
    "username": "user123"
  }
}

Delete Asset

Delete an existing asset | key: deleteAsset

Input	Notes	Example
Connection
ID	The ID of the resource to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Delete Asset Metaproperty Options

Remove metaproperty options from an asset | key: deleteAssetMetapropertyOptions

Input	Notes	Example
Asset ID	Id of the asset.	00000000-0000-0000-0000000000000000
Connection
Metaproperty ID	Id of the metaproperty from which you want to add options.	00000000-0000-0000-0000000000000000
Metaproperty Options IDs	List of metaproperty option ids you want to add to the asset.	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Delete Campaign

Delete an existing campaign | key: deleteCampaign

Input	Notes	Example
Connection
Campaign ID	The ID of the campaign to delete	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Delete Collection

Delete an existing collection | key: deleteCollection

Input	Notes	Example
Connection
Collection ID	The ID of the collection to delete	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Delete Job

Delete an existing job | key: deleteJob

Input	Notes	Example
Connection
Job ID	The ID of the job to delete	00000000-0000-0000-0000000000000000

{
  "data": {}
}

Delete User

Remove an existing user | key: deleteUser

Input	Notes	Example
Connection
ID	The ID of the resource to retrieve	00000000-0000-0000-0000000000000000

Download Specific Asset Item

Download an specific asset item | key: downloadSpecificAssetItem

Input	Notes	Example
Connection
Hash	Indicates whether or not to treat the itemId as a hashed item id	false
Asset ID	The id of the asset you’d like to download a item of.	00000000-0000-0000-0000000000000000
Item ID	The id of the specific asset item you’d like to download.	00000000-0000-0000-0000000000000000

{
  "data": {
    "disclaimer": "<p>1. The photographs and video in the mediabank are to be used by anyone and everyone.</p>",
    "s3_file": "___TEMPORARY_DOWNLOAD_URL___"
  }
}

Finalize Complete Upload

Finalize a completely uploaded file. | key: finaliseCompleteUpload

Input	Notes	Example
Chunks	Total number of chunks uploaded.
Connection
ID	ID of the upload.	T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
Original Filename	Filename including special characters to be displayed in Bynder.	Logo.png
S3 Filename	Base location of the uploaded file.	api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png
Target ID	The targetid that was returned by the initialize call.	final/00000000-0000-0000-0000000000000000/Logo.png

{
  "data": {
    "output": "final/2ba07d00-586a-4a44-b13c-c58598cfe828/",
    "batchId": "00000000-0000-0000-0000000000000000",
    "file": {
      "bucket": "BUCKET",
      "path": "final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG",
      "type": "s3"
    },
    "filename": "final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG",
    "importId": "000000000-0000-0000-0000000000000000",
    "locationType": "s3",
    "success": 1
  }
}

Finalize Complete Upload And Save As New Asset Additional

Finalize a completely uploaded file and save as a new asset additional. | key: finaliseCompleteUploadAndSaveAsNewAsset

Input	Notes	Example
Asset ID	Asset id to which to save the new additional.	00000000-0000-0000-0000000000000000
Chunks	Total number of chunks uploaded.
Connection
S3 Filename	Base location of the uploaded file or filename result from the last upload chunk action.	api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png/p{chunks}
Target ID	The targetid that was returned by the initialize call.	final/00000000-0000-0000-0000000000000000/Logo.png
ID	ID of the upload.	T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM

{
  "data": {
    "itemId": "21F24BCF-DD76-4FE3-9B7C5936A2FA958C"
  }
}

Generate Dynamic Asset Transformation

Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it | key: generateDynamicTransformation

Input	Notes	Example
Connection
Focus Point	Focus point as a x,y coordinate (with values between 0 - 1). This will serve as the center point for the image operations.	0.5,0.25
Format	Format of the served image. This can either be jpg or png and it will overwrite the default webP.	jpg
ID	The ID of the resource to retrieve	00000000-0000-0000-0000000000000000
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.	transform:crop,width:100,height:200
Name	Name of the asset, beware the asset will have no name when this is empty.	Asset Name
Format	Image quality, ranging from 1 - 100 (has no effect when format is set to 'png').	75

{
  "data": {}
}

Get Account Information

Retrieve information on current account | key: getAccountInformation

Input	Notes	Example
Connection

{
  "data": {
    "availableLanguages": [
      "nl_NL",
      "en_GB",
      "en_US",
      "fr_FR",
      "de_DE",
      "it_IT",
      "es_ES",
      "pl_PL"
    ],
    "defaultLanguage": "en_US",
    "name": "Bynder",
    "timeZone": "Europe/Amsterdam",
    "isOpenImageBank": false
  }
}

Get Asset

Retrieve a specific asset | key: getAsset

Input	Notes	Example
Connection
ID	The ID of the resource to retrieve	00000000-0000-0000-0000000000000000
Stats	Include information about views and downloads.	false
Versions	Include information about the different asset media items including versions.	false

{
  "data": {
    "dateModified": "2017-03-09T12:09:29Z",
    "propertyOptions": [
      "00000000-0000-0000-0000000000000000",
      "00000000-0000-0000-0000000000000001"
    ],
    "type": "image",
    "brandId": "00000000-0000-0000-0000000000000000",
    "fileSize": 3895890,
    "id": "00000000-0000-0000-0000000000000000",
    "height": 3301,
    "description": "Beautiful grassland picture",
    "idHash": "02c3c00b6388a63f",
    "name": "Grassland",
    "tags": [
      "2014",
      "25249181"
    ],
    "orientation": "landscape",
    "width": 4951,
    "datePublished": "2017-03-07T14:28:56Z",
    "copyright": "",
    "extension": [
      "jpeg"
    ],
    "userCreated": "John Doe",
    "dateCreated": "2017-03-07T14:28:57Z",
    "archive": 0,
    "property_limitedrights": "Specific rights",
    "watermarked": 0,
    "limited": 0,
    "isPublic": 0,
    "thumbnails": {
      "mini": "___URL_TO_BYNDER_CDN___",
      "webimage": "___URL_TO_BYNDER_CDN___",
      "thul": "___URL_TO_BYNDER_CDN___"
    },
    "transformBaseUrl": "https://example.bynder.com/transform/01234567-89ab-cdef-0123-456789abcdef/AssetName"
  }
}

Get Campaign

Retrieve a specific campaign | key: getCampaign

Input	Notes	Example
Connection
Campaign ID	The ID of the campaign to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "dateStart": "2017-02-01T00:00:00+00:00",
    "description": "Campaign example",
    "responsibleID": "00000000-0000-0000-0000-000000000000",
    "dateModified": "2017-01-10T07:43:12+00:00",
    "dateCreated": "2017-01-10T07:43:12+00:00",
    "ID": "00000000-0000-0000-0000-000000000000",
    "presetID": "00000000-0000-0000-0000-000000000000",
    "deadline": "2017-03-03T00:00:00",
    "createdByID": "00000000-0000-0000-0000-000000000000",
    "accountID": "00000000-0000-0000-0000-000000000000",
    "closed": false,
    "key": "excp",
    "name": "Example campaign",
    "thumbnailURL": "https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg",
    "campaignMetaproperties": "00000000-0000-0000-0000-000000000000"
  }
}

Get Closest S3 Upload Endpoint

Retrieve the closest S3 upload endpoint | key: getClosestS3Endpoint

Input	Notes	Example
Connection

{
  "data": "https://bynder-public-eu-central-1.s3.amazonaws.com/"
}

Get Collection

Retrieve a specific collection | key: getCollection

Input	Notes	Example
Connection
Collection ID	The ID of the collection to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "userId": "48817BA7-2FC3-4A43-918761514D322C15",
    "dateModified": "March, 08 2017 14:17:37 +0000",
    "filename": "collection_1",
    "dateCreated": "March, 01 2017 10:49:12 +0000",
    "collectionCount": 2,
    "id": "00B627BB-8054-44C0-A343FCF40BC790CD",
    "name": "Collection 1",
    "cover": {
      "thumbnail": "___URL_TO_BYNDER_CDN___",
      "thumbnails": [
        "___URL_TO_BYNDER_CDN___",
        "___URL_TO_BYNDER_CDN___",
        "___URL_TO_BYNDER_CDN___"
      ],
      "large": "___URL_TO_BYNDER_CDN___"
    },
    "user": {
      "id": "48817BA7-2FC3-4A43-918761514D322C15",
      "name": "John Doe"
    },
    "description": "Collection 1 with various assets.",
    "IsPublic": 1
  }
}

Get Current User

Retrieve the current user | key: getCurrentUser

Input	Notes	Example
Connection

{
  "data": {
    "phoneNumber": "+00 123456789",
    "profileId": "00000000-0000-0000-0000000000000000",
    "lastLogin": "2017-03-10T15:42:03Z",
    "department": "Development",
    "job": "Developer",
    "state": "",
    "firstname": "John",
    "city": "Amsterdam",
    "infix": "",
    "timeZone": "Africa/Lusaka",
    "username": "user123",
    "email": "john.doe@xample.com",
    "persisted": true,
    "legalEntity": "",
    "county": "",
    "postalCode": "",
    "language": "en_GB",
    "country": "Netherlands",
    "costCenter": "",
    "groups": [
      {
        "name": "Bynder",
        "id": "00000000-0000-0000-0000000000000000"
      },
      {
        "name": "Product",
        "id": "00000000-0000-0000-0000000000000000"
      }
    ],
    "lastname": "Doe",
    "cellphoneNumber": "",
    "employeeNumber": "",
    "departmentCode": "",
    "gender": "U",
    "id": "00000000-0000-0000-0000000000000000",
    "companyName": "Bynder",
    "active": true,
    "isSSOOnly": false,
    "address": "",
    "terms": "Digital Asset Management System Terms and Conditions <br/>\n<br/>\n  Overview<br/><br/>\n  All assets are free to use as long as these terms and conditions and license rules are followed.\nAll assets can not be used in paid advertising without the permission of Bynder.<br/><br/>"
  }
}

Get Job

Retrieve a job by ID | key: getJob

Input	Notes	Example
Connection
Job ID	The ID of the job to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "job_stages": [
      {
        "position": 1,
        "status": "Approved",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "position": 2,
        "status": "Active",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "position": 3,
        "status": "Idle",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "dateModified": "2017-03-30T11:43:19+00:00",
    "presetID": null,
    "createdByID": "00000000-0000-0000-0000-000000000000",
    "job_next_stage": {
      "position": 3,
      "status": "Idle",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "",
    "accountableID": "00000000-0000-0000-0000-000000000000",
    "basedOnPreset": false,
    "dateCreated": "2017-03-30T11:42:30+00:00",
    "job_active_stage": {
      "position": 2,
      "status": "Active",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "deadline": null,
    "name": "Test API",
    "campaignID": "00000000-0000-0000-0000-000000000000",
    "job_previous_stage": {
      "position": 1,
      "status": "Approved",
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

Get Job Preset

Retrieve a job preset by ID | key: getJobPreset

Input	Notes	Example
Connection
Job preset ID	The ID of the job preset to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "preset": {
      "ID": "00000000-0000-0000-0000-000000000000",
      "name": "API name",
      "wf_uuid": "00000000-0000-0000-0000-000000000000",
      "ftp_settings": {},
      "presetstages": [
        {
          "description": "",
          "ID": "00000000-0000-0000-0000-000000000000",
          "name": "Revision Stage ",
          "position": 1,
          "editableBy": "all",
          "restrictToGroupID": null,
          "type": "download",
          "responsibleID": null,
          "responsibleGroupID": null
        }
      ]
    }
  }
}

Get Media of Job

Retrieve media attached to an existing job | key: getMediaOfJob

Input	Notes	Example
Connection
Job ID	The ID of the job to retrieve	00000000-0000-0000-0000000000000000

{
  "data": [
    {
      "original_url": "https://url.to.file/original.png",
      "filename": "filename.png",
      "orientation": "square",
      "status": "AwaitingApproval",
      "dateCreated": "2021-05-12T08:48:01+00:00",
      "dateModified": "2021-05-12T08:51:22+00:00",
      "responsible_name": "John Doe",
      "version": 1,
      "uploader_name": "John Doe",
      "versionParentID": null,
      "id": "00000000-0000-0000-0000-000000000000",
      "previews": [
        {
          "type": "thumbnail",
          "url": "https://url.to.file/preview.png"
        },
        {
          "type": "preview",
          "url": "https://url.to.file/preview.png"
        },
        {
          "type": "activity",
          "url": "https://url.to.file/preview.png"
        }
      ],
      "sub_versions": [
        {
          "original_url": "https://url.to.file/original.png",
          "filename": "filename.png",
          "orientation": "square",
          "status": "AwaitingApproval",
          "dateCreated": "2021-05-13T08:48:01+00:00",
          "dateModified": "2021-05-13T08:51:22+00:00",
          "responsible_name": "John Doe",
          "version": 2,
          "uploader_name": "John Doe",
          "versionParentID": "00000000-0000-0000-0000-000000000000",
          "id": "00000000-0000-0000-0000-000000000000",
          "previews": [
            {
              "type": "thumbnail",
              "url": "https://url.to.file/preview.png"
            },
            {
              "type": "preview",
              "url": "https://url.to.file/preview.png"
            },
            {
              "type": "activity",
              "url": "https://url.to.file/preview.png"
            }
          ],
          "sub_versions": []
        }
      ]
    }
  ]
}

Get Order

Retrieve an existing order | key: getOrder

Input	Notes	Example
Connection
Order ID	The ID of the order to retrieve. Either id or orderNumber is required	00000000-0000-0000-0000000000000000
Order Number	The order number of the order to retrieve. Either id or orderNumber is required	00000000-0000-0000-0000000000000000

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "orderId": "00000000-0000-0000-0000-000000000000",
      "product": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Train the trainer product",
        "description": "This is such a nice product!",
        "isFeatured": false,
        "product_number": "999999999",
        "supplier_number": null,
        "size_height": 1,
        "size_width": 1,
        "size_depth": 1,
        "weight": 1,
        "min_quantity": 1,
        "max_quantity": 10,
        "default_quantity": 1,
        "datecreated": "2016-08-10T12:14:16+00:00",
        "isActive": true,
        "product_type": "print",
        "product_package": "unit",
        "countries": null,
        "sku": "1",
        "step": 1,
        "display_length_unit": "cm",
        "isFree": false,
        "pages": null,
        "language": null,
        "supplier_version_specifier": null,
        "isShipping": false
      },
      "referenceId": "999999999",
      "name": "Train the trainer product",
      "description": "",
      "itemPrice": 0.2333,
      "quantity": 3,
      "supplier": null,
      "customerReference": null,
      "metaproperties": null
    }
  ]
}

Get Order Info

Retrieve information on an order | key: getOrderInfo

Input	Notes	Example
Connection
Order ID	The ID of the order to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "id": "00000000-0000-0000-0000000000000000",
    "dateCreated": "2015-06-01T08:36:18Z",
    "status": "IN_PRODUCTION",
    "orderReference": "NL0456"
  }
}

Get Security Profile

Retrieve a specified security profile | key: getSecurityProfile

Input	Notes	Example
Connection
Security Profile ID	The ID of the security profile to retrieve.	00000000-0000-0000-0000000000000000

{
  "data": {
    "name": "Internal Limited user",
    "id": "00000000-0000-0000-0000000000000001",
    "roles": [
      "MEDIADOWNLOAD",
      "SHARING",
      "MEDIAOVERVIEW",
      "MEDIAHIGHRES"
    ]
  }
}

Get User

Retrieve a specified user | key: getUser

Input	Notes	Example
Connection
ID	The ID or username of the user to retrieve	00000000-0000-0000-0000000000000000

{
  "data": {
    "phoneNumber": "+00 123456789",
    "profileId": "00000000-0000-0000-0000000000000000",
    "lastLogin": "2017-03-10T15:42:03Z",
    "department": "Development",
    "job": "Developer",
    "state": "",
    "firstname": "John",
    "city": "Amsterdam",
    "infix": "",
    "timeZone": "Africa/Lusaka",
    "username": "user123",
    "email": "john.doe@xample.com",
    "persisted": true,
    "legalEntity": "",
    "county": "",
    "postalCode": "",
    "language": "en_GB",
    "country": "Netherlands",
    "costCenter": "",
    "groups": [
      {
        "name": "Bynder",
        "id": "00000000-0000-0000-0000000000000000"
      },
      {
        "name": "Product",
        "id": "00000000-0000-0000-0000000000000000"
      }
    ],
    "lastname": "Doe",
    "cellphoneNumber": "",
    "employeeNumber": "",
    "departmentCode": "",
    "gender": "U",
    "id": "00000000-0000-0000-0000000000000000",
    "companyName": "Bynder",
    "active": true,
    "isSSOOnly": false,
    "address": "",
    "terms": "Digital Asset Management System Terms and Conditions <br/>\n<br/>\n  Overview<br/><br/>\n  All assets are free to use as long as these terms and conditions and license rules are followed.\nAll assets can not be used in paid advertising without the permission of Bynder.<br/><br/>"
  }
}

Initialize Upload

Initialize a new file upload. | key: initialiseUpload

Input	Notes	Example
Connection
Filename	Filename of new upload (extension required).	image.jpeg

{
  "data": {
    "s3file": {
      "uploadid": "UPLOAD_ID",
      "targetid": "final/00000000-0000-0000-0000-000000000000/image.jpeg"
    },
    "s3_filename": "pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg",
    "target_key": "pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg",
    "multipart_params": {
      "acl": "private",
      "success_action_status": "201",
      "Content-Type": "image/*",
      "key": "pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg",
      "Policy": "AWS_S3_POLICY",
      "X-Amz-Signature": "AWS_S3_SIGNATURE",
      "x-amz-credential": "AWS_S3_AUTH",
      "x-amz-algorithm": "AWS4-HMAC-SHA256",
      "x-amz-date": "20160216T100755Z"
    }
  }
}

List Assets

Retrieve all assets | key: listAssets

Input	Notes	Example
Connection
Count	Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.	false
Extra Parameters	Extra parameters to be included in the request.
Fetch All	Whether to fetch all results. If true, limit and page parameters are ignored.	true
Limit	Maximum number of results. Maximum: 1000. Default: 50	100
Page	The page number to retrieve	1
Total	Indicating whether or not the response should include the total count of results.	false

{
  "data": [
    {
      "dateModified": "2017-03-09T12:09:29Z",
      "propertyOptions": [
        "00000000-0000-0000-0000000000000000",
        "00000000-0000-0000-0000000000000001"
      ],
      "type": "image",
      "brandId": "00000000-0000-0000-0000000000000000",
      "fileSize": 3895890,
      "id": "00000000-0000-0000-0000000000000000",
      "height": 3301,
      "description": "Beautiful grassland picture",
      "idHash": "02c3c00b6388a63f",
      "name": "Grassland",
      "tags": [
        "2014",
        "25249181"
      ],
      "orientation": "landscape",
      "width": 4951,
      "datePublished": "2017-03-07T14:28:56Z",
      "copyright": "",
      "extension": [
        "jpeg"
      ],
      "userCreated": "John Doe",
      "dateCreated": "2017-03-07T14:28:57Z",
      "archive": 0,
      "property_limitedrights": "Specific rights",
      "watermarked": 0,
      "limited": 0,
      "isPublic": 0,
      "thumbnails": {
        "mini": "___URL_TO_BYNDER_CDN___",
        "webimage": "___URL_TO_BYNDER_CDN___",
        "thul": "___URL_TO_BYNDER_CDN___"
      },
      "transformBaseUrl": "https://example.bynder.com/transform/01234567-89ab-cdef-0123-456789abcdef/AssetName"
    },
    {
      "dateModified": "2015-07-28T10:46:59Z",
      "propertyOptions": [
        "00000000-0000-0000-0000000000000000",
        "00000000-0000-0000-0000000000000001"
      ],
      "type": "video",
      "brandId": "00000000-0000-0000-0000000000000000",
      "fileSize": 63973541,
      "id": "00000000-0000-0000-0000000000000001",
      "height": 0,
      "description": "",
      "idHash": "536f140e0ba62e46",
      "name": "App Instruction Video",
      "tags": [
        "tutorial videos",
        "tutorial",
        "video"
      ],
      "orientation": "landscape",
      "width": 0,
      "datePublished": "2015-07-23T10:46:00Z",
      "copyright": "",
      "extension": [
        "mp4"
      ],
      "userCreated": "",
      "dateCreated": "2015-07-23T17:20:19Z",
      "archive": 0,
      "property_assettype": [
        "video"
      ],
      "watermarked": 0,
      "limited": 1,
      "videoPreviewURLs": [
        "___URL_TO_BYNDER_CDN___.webm",
        "___URL_TO_BYNDER_CDN___.mp4"
      ],
      "thumbnails": {
        "mini": "___URL_TO_BYNDER_CDN___",
        "webimage": "___URL_TO_BYNDER_CDN___",
        "67E391FA": "___URL_TO_BYNDER_CDN___",
        "thul": "___URL_TO_BYNDER_CDN___"
      },
      "isPublic": 1,
      "original": "___URL_TO_BYNDER_CDN___",
      "transformBaseUrl": "https://example.bynder.com/transform/01234567-89ab-cdef-0123-456789abcdef/AssetName"
    }
  ]
}

List Brands

Retrieve all brands | key: listBrands

Input	Notes	Example
Connection

{
  "data": [
    {
      "image": "___URL_TO_BYNDER_CDN___",
      "name": "Bynder Brand Portal",
      "id": "00000000-0000-0000-0000000000000000",
      "description": "",
      "subBrands": [
        {
          "id": "00000000-0000-0000-0000000000000000",
          "description": "",
          "name": "Sub Portal One",
          "image": ""
        },
        {
          "id": "00000000-0000-0000-0000000000000001",
          "description": "",
          "name": "Sub Portal Two",
          "image": ""
        }
      ]
    },
    {
      "image": "___URL_TO_BYNDER_CDN___",
      "name": "Byndy Brand Portal",
      "id": "00000000-0000-0000-0000000000000001",
      "description": "",
      "subBrands": []
    }
  ]
}

List Campaigns

Retrieve all campaigns | key: listCampaigns

Input	Notes	Example
Connection

{
  "data": [
    {
      "dateStart": "2017-02-01T00:00:00+00:00",
      "description": "Campaign example",
      "responsibleID": "00000000-0000-0000-0000-000000000000",
      "dateModified": "2017-01-10T07:43:12+00:00",
      "dateCreated": "2017-01-10T07:43:12+00:00",
      "ID": "00000000-0000-0000-0000-000000000000",
      "deadline": "2017-03-03T00:00:00",
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "accountID": "00000000-0000-0000-0000-000000000000",
      "presetID": "00000000-0000-0000-0000-000000000000",
      "closed": false,
      "key": "excp",
      "name": "Example campaign",
      "thumbnailURL": "https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg",
      "campaignMetaproperties": "00000000-0000-0000-0000-000000000000"
    },
    {
      "dateStart": "2017-02-01T00:00:00+00:00",
      "description": "Campaign example",
      "responsibleID": "00000000-0000-0000-0000-000000000000",
      "dateModified": "2017-01-10T07:43:12+00:00",
      "dateCreated": "2017-01-10T07:43:12+00:00",
      "ID": "00000000-0000-0000-0000-000000000000",
      "deadline": "2017-03-03T00:00:00",
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "accountID": "00000000-0000-0000-0000-000000000000",
      "presetID": "00000000-0000-0000-0000-000000000000",
      "closed": false,
      "key": "excp",
      "name": "Example campaign",
      "thumbnailURL": "https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg",
      "campaignMetaproperties": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

List Collections

Retrieve all collections | key: listCollections

Input	Notes	Example
Connection
Count	Indicating whether or not the response should include count results. This parameter when passed as true overrides the total parameter.	false
Extra Parameters	Extra parameters to be included in the request.
Fetch All	Whether to fetch all results. If true, limit and page parameters are ignored.	true
Limit	Maximum results to return. If limit is not provided, all results are returned.	100
Page	The page number to retrieve	1

{
  "data": {
    "collections": [
      {
        "userId": "48817BA7-2FC3-4A43-918761514D322C15",
        "dateModified": "March, 08 2017 14:17:37 +0000",
        "filename": "collection_1",
        "dateCreated": "March, 01 2017 10:49:12 +0000",
        "collectionCount": 2,
        "id": "00B627BB-8054-44C0-A343FCF40BC790CD",
        "name": "Collection 1",
        "cover": {
          "thumbnail": "___URL_TO_BYNDER_CDN___",
          "thumbnails": [
            "___URL_TO_BYNDER_CDN___",
            "___URL_TO_BYNDER_CDN___",
            "___URL_TO_BYNDER_CDN___"
          ],
          "large": "___URL_TO_BYNDER_CDN___"
        },
        "user": {
          "id": "48817BA7-2FC3-4A43-918761514D322C15",
          "name": "John Doe"
        },
        "description": "Collection 1 with various assets.",
        "IsPublic": 1
      },
      {
        "userId": "80E53210-5BB0-4BF9-907F917D457801BB",
        "dateModified": "March, 10 2017 07:57:18 +0000",
        "filename": "collection_2",
        "dateCreated": "October, 30 2014 13:54:00 +0000",
        "collectionCount": 4,
        "id": "050960F7-98B3-461D-B967F4B84D3A3866",
        "name": "Collection 2",
        "cover": {
          "thumbnail": "___URL_TO_BYNDER_CDN___",
          "thumbnails": [
            "___URL_TO_BYNDER_CDN___",
            "___URL_TO_BYNDER_CDN___",
            "___URL_TO_BYNDER_CDN___"
          ],
          "large": "___URL_TO_BYNDER_CDN___"
        },
        "user": {
          "id": "80E53210-5BB0-4BF9-907F917D457801BB",
          "name": "Jane Doe"
        },
        "description": "Collection 2 with various assets.",
        "IsPublic": 0
      }
    ],
    "count": 151
  }
}

List Jobs

Retrieve all jobs | key: listJobs

Input	Notes	Example
Connection
Extra Parameters	Extra parameters to be included in the request.
Limit	Maximum results to return. If limit is not provided, all results are returned.	100
Page	The page number to retrieve	1

{
  "data": [
    {
      "job_stages": [
        {
          "position": 1,
          "status": "Approved",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 2,
          "status": "Active",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 3,
          "status": "Idle",
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "dateModified": "2017-03-30T11:43:19+00:00",
      "presetID": null,
      "jobMetaproperties": {
        "00000000-0000-0000-0000-000000000000": "City"
      },
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "job_next_stage": {
        "position": 3,
        "status": "Idle",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "accountableID": "00000000-0000-0000-0000-000000000000",
      "basedOnPreset": false,
      "dateCreated": "2017-03-30T11:42:30+00:00",
      "job_active_stage": {
        "position": 2,
        "status": "Active",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "deadline": null,
      "name": "Test API",
      "campaignID": "00000000-0000-0000-0000-000000000000",
      "job_previous_stage": {
        "position": 1,
        "status": "Approved",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    },
    {
      "job_stages": [
        {
          "position": 1,
          "status": "Approved",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 2,
          "status": "Active",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 3,
          "status": "Idle",
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "dateModified": "2017-03-30T11:43:19+00:00",
      "presetID": null,
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "job_next_stage": {
        "position": 3,
        "status": "Idle",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "accountableID": "00000000-0000-0000-0000-000000000000",
      "basedOnPreset": false,
      "dateCreated": "2017-03-30T11:42:30+00:00",
      "job_active_stage": {
        "position": 2,
        "status": "Active",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "deadline": null,
      "name": "Test API",
      "campaignID": "00000000-0000-0000-0000-000000000000",
      "job_previous_stage": {
        "position": 1,
        "status": "Approved",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "headers": {}
}

List Jobs By Campaign

Retrieve jobs tied to a campaign | key: listJobsByCampaign

Input	Notes	Example
Connection
Extra Parameters	Extra parameters to be included in the request.
Campaign ID	The ID of the campaign to retrieve jobs for	00000000-0000-0000-0000000000000000
Limit	Maximum results to return. If limit is not provided, all results are returned.	100
Page	The page number to retrieve	1

{
  "data": [
    {
      "job_stages": [
        {
          "position": 1,
          "status": "Approved",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 2,
          "status": "Active",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 3,
          "status": "Idle",
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "dateModified": "2017-03-30T11:43:19+00:00",
      "presetID": null,
      "jobMetaproperties": {
        "00000000-0000-0000-0000-000000000000": "City"
      },
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "job_next_stage": {
        "position": 3,
        "status": "Idle",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "accountableID": "00000000-0000-0000-0000-000000000000",
      "basedOnPreset": false,
      "dateCreated": "2017-03-30T11:42:30+00:00",
      "job_active_stage": {
        "position": 2,
        "status": "Active",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "deadline": null,
      "name": "Test API",
      "campaignID": "00000000-0000-0000-0000-000000000000",
      "job_previous_stage": {
        "position": 1,
        "status": "Approved",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    },
    {
      "job_stages": [
        {
          "position": 1,
          "status": "Approved",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 2,
          "status": "Active",
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "position": 3,
          "status": "Idle",
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "dateModified": "2017-03-30T11:43:19+00:00",
      "presetID": null,
      "createdByID": "00000000-0000-0000-0000-000000000000",
      "job_next_stage": {
        "position": 3,
        "status": "Idle",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "accountableID": "00000000-0000-0000-0000-000000000000",
      "basedOnPreset": false,
      "dateCreated": "2017-03-30T11:42:30+00:00",
      "job_active_stage": {
        "position": 2,
        "status": "Active",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "deadline": null,
      "name": "Test API",
      "campaignID": "00000000-0000-0000-0000-000000000000",
      "job_previous_stage": {
        "position": 1,
        "status": "Approved",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "headers": {}
}

List Metaproperties

Retrieve all metaproperties. | key: listMetaproperties

Input	Notes	Example
Connection
Count	Indicates whether or not the response should include asset count results for metaproperty-options.	false
IDs	List of metaproperty ids. Will return a metaproperty for each existing id.
Format	Indicates whether or not the response should include the metaproperty options of each metaproperty.	false
Type	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 true.

{
  "data": {
    "Colours": {
      "isMultiselect": 0,
      "isMultifilter": 0,
      "isRequired": 0,
      "isMainfilter": 1,
      "isFilterable": 1,
      "isApiField": 1,
      "isDisplayField": 0,
      "isDrilldown": 0,
      "isEditable": 1,
      "name": "colours",
      "label": "Colours",
      "zindex": 16,
      "id": "00000000-0000-0000-0000000000000000",
      "type": "sidebar",
      "showInListView": 1,
      "showInGridView": 0,
      "showInDuplicateView": 0,
      "useDependencies": 0,
      "options": [
        {
          "displayLabel": "Yellow",
          "date": "February, 15 2017 14:54:58 +0000",
          "pregeneratedZipFileSize": 0,
          "linkedOptionIds": [],
          "isSelectable": 1,
          "zindex": 1,
          "product_suffix": "",
          "name": "yellow",
          "id": "00000000-0000-0000-0000000000000000",
          "active": 1,
          "label": "Yellow",
          "labels": {
            "nl_NL": "Geel",
            "en_US": "Yellow"
          },
          "descriptions": {},
          "description": "",
          "hideByDefault": 0,
          "image": "___URL_TO_BYNDER_CDN___"
        },
        {
          "displayLabel": "Red",
          "date": "February, 15 2017 15:50:55 +0000",
          "pregeneratedZipFileSize": 0,
          "linkedOptionIds": [],
          "isSelectable": 1,
          "zindex": 1,
          "product_suffix": "",
          "name": "red",
          "id": "00000000-0000-0000-0000000000000001",
          "active": 1,
          "label": "Red",
          "labels": {
            "nl_NL": "Rood",
            "en_US": "Red"
          },
          "descriptions": {},
          "description": "",
          "hideByDefault": 0,
          "image": "___URL_TO_BYNDER_CDN___"
        }
      ]
    },
    "Bob_button": {
      "isMultiselect": 0,
      "isMultifilter": 0,
      "isRequired": 0,
      "isMainfilter": 1,
      "isFilterable": 1,
      "isApiField": 1,
      "isDisplayField": 0,
      "isDrilldown": 0,
      "isEditable": 1,
      "name": "Bob_button",
      "label": "Bob_button",
      "zindex": 2,
      "id": "00000000-0000-0000-0000000000000001",
      "type": "button",
      "showInListView": 1,
      "showInGridView": 0,
      "showInDuplicateView": 0,
      "useDependencies": 0,
      "options": []
    }
  }
}

List Orders

Retrieve all orders. | key: listOrders

Input	Notes	Example
Connection
Page	Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10.	1

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "order_ref": "NA13334",
      "net_price": 0,
      "date_created": "2018-10-25T14:26:01+00:00",
      "username": "john.doe@bynder.com",
      "account_name": "Bynder",
      "order_status": "In production",
      "currency_symbol": "8364"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "order_ref": "US12774",
      "net_price": 79,
      "date_created": "2018-09-10T12:12:21+00:00",
      "username": "john.doe@bynder.com",
      "account_name": "Bynder",
      "order_status": "Waiting for approval",
      "currency_symbol": "36"
    }
  ]
}

List Security Profiles

Retrieve all security profiles | key: listSecurityProfiles

Input	Notes	Example
Connection

{
  "data": [
    {
      "name": "Internal Limited user",
      "id": "00000000-0000-0000-0000000000000001",
      "roles": [
        "MEDIADOWNLOAD",
        "SHARING",
        "MEDIAOVERVIEW",
        "MEDIAHIGHRES"
      ]
    },
    {
      "name": "Content/Brand Manager",
      "id": "00000000-0000-0000-0000000000000000",
      "roles": [
        "PUBLICCOLLECTIONS",
        "GROUPSHARING",
        "COLLECTIONS"
      ]
    }
  ]
}

List Users

Retrieve all users | key: listUsers

Input	Notes	Example
Connection
Include Inactive	Whether to include inactive users in the list of results.	false
Limit	Maximum results to return. If limit is not provided, all results are returned.	100
Page	The page number to retrieve	1

{
  "data": [
    {
      "email2": "__USER_EMAIL_2__",
      "salesrepId": "",
      "name": "David",
      "id": "00000000-0000-0000-0000000000000000",
      "active": 1,
      "isSSOOnly": false,
      "username": "__USER_USERNAME__",
      "email": "__USER_EMAIL__",
      "profileId": "00000000-0000-0000-0000000000000000",
      "groups": [
        {
          "name": "Bynder",
          "id": "00000000-0000-0000-0000000000000000"
        },
        {
          "name": "Product",
          "id": "00000000-0000-0000-0000000000000000"
        }
      ]
    },
    {
      "email2": "__USER_EMAIL_2__",
      "salesrepId": "",
      "name": "Jake",
      "id": "00000000-0000-0000-0000000000000001",
      "active": 1,
      "isSSOOnly": true,
      "username": "__USER_USERNAME__",
      "email": "__USER_EMAIL__",
      "profileId": "00000000-0000-0000-0000000000000000",
      "groups": [
        {
          "name": "Bynder",
          "id": "00000000-0000-0000-0000000000000000"
        }
      ]
    }
  ],
  "headers": {}
}

Raw Request

Send raw HTTP request to Bynder | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	This is the URL to call.	Input the path only (/v4/media/), The base URL is already included (https://your-bynder-domain/api/). For example, to connect to https://your-bynder-domain/api/v4/media/, only /v4/media/ is entered in this field. e.g. /v4/media/
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Register Uploaded Chunk

Input	Notes	Example
Chunk Number	Number of the chunk that was uploaded.
Connection
Filename	Location of the uploaded chunk.	api_uploads/00000000-0000-0000-0000000000000000/00000000-0000-0000-0000000000000000/Logo.png/p5
ID	ID of the upload.	T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
Target ID	The targetid that was returned by the initialize call.	final/00000000-0000-0000-0000000000000000/Logo.png

{
  "data": {
    "status": "ok"
  }
}

Retrieve Poll State

Poll processing state of finalized files | key: retrievePollState

Input	Notes	Example
Connection
Items	Comma-separated import id's of a finalized file, as returned by the finalize call.	000000000-0000-0000-0000000000000000

{
  "data": {
    "itemsDone": [
      "00000000-0000-0000-0000000000000000"
    ],
    "itemsFailed": [],
    "itemsRejected": []
  }
}

Save a New Asset

Save a completed upload as a new asset. | key: saveAsNewAsset

Input	Notes	Example
Data	Data of the new asset.
Brand ID	Brand id to save the asset to.	00000000-0000-0000-0000000000000000
Connection
Copyright	Copyright information of the asset.	Copyright (c) Example corp
Description	Asset description.	Extended asset description
Import ID	Import id of a finalized and processed upload to be saved.	00000000-0000-0000-0000000000000000
Asset Name	Name of the new asset.	Logo

{
  "data": {
    "accessRequestId": "00000000-0000-0000-0000000000000000",
    "mediaid": "00000000-0000-0000-0000000000000000",
    "batchId": "00000000-0000-0000-0000000000000000",
    "success": true,
    "mediaitems": [
      {
        "original": "final/00000000-0000-0000-0000000000000000/image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      },
      {
        "original": "final/00000000-0000-0000-0000000000000000/thul-image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      },
      {
        "original": "final/00000000-0000-0000-0000000000000000/mini-image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      }
    ]
  }
}

Save as a New Asset Version

Save a completed upload as a new asset version. | key: saveAsNewAssetVersion

Input	Notes	Example
Asset ID	Asset id for which to save the new version.	00000000-0000-0000-0000000000000000
Connection
Import ID	Import id of a finalized and processed upload to be saved.	00000000-0000-0000-0000000000000000

{
  "data": {
    "accessRequestId": "00000000-0000-0000-0000000000000000",
    "mediaid": "00000000-0000-0000-0000000000000000",
    "batchId": "00000000-0000-0000-0000000000000000",
    "success": true,
    "mediaitems": [
      {
        "original": "final/00000000-0000-0000-0000000000000000/image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      },
      {
        "original": "final/00000000-0000-0000-0000000000000000/thul-image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      },
      {
        "original": "final/00000000-0000-0000-0000000000000000/mini-image.jpg",
        "destination": "___URL_TO_BYNDER_CDN___"
      }
    ]
  }
}

Share Collection

Share a collection | key: shareCollection

Input	Notes	Example
Data	Extra fields to be included in the request. Must be valid JSON.
Collection Options	Recipient rights.
Connection
Groups	Comma-separated list of group ids. Mandatory if recipients or profiles are empty.	000000000-0000-0000-0000000000000000
Collection ID	The ID of the collection to retrieve	00000000-0000-0000-0000000000000000
Profiles	Comma-separated list of profile ids. Mandatory if recipients or groups are empty.	000000000-0000-0000-0000000000000000
Recipients	Comma-separated email addresses of recipients. Mandatory if groups or profiles are empty.	user1@bynder.com,user2@bynder.com

{
  "data": {
    "message": "Accepted",
    "statuscode": 202
  }
}

Update Asset

Edit an existing asset | key: updateAsset

Input	Notes	Example
Data	Extra fields to be included in the request. Must be valid JSON.
Connection
Copyright	Copyright information of the asset.	Copyright (c) Example corp
Description	Asset description.	Extended asset description
ID	The ID of the resource to retrieve	00000000-0000-0000-0000000000000000
Name	Name of the asset, beware the asset will have no name when this is empty.	Asset Name

{
  "data": {
    "message": "Accepted",
    "statuscode": 202
  }
}

Update Campaign

Edit an existing campaign | key: updateCampaign

Input	Notes	Example
Data	Additional data to update the campaign
Connection
Description	The description of the campaign	Extended asset description
Campaign ID	The ID of the campaign to update	00000000-0000-0000-0000000000000000
Key	4 character key representing the campaign	excp
Name	The name of the campaign	Asset Name
Responsible ID	Id of the user responsible for the campaign	00000000-0000-0000-0000-000000000000

{
  "data": {
    "name": "Example campaign",
    "key": "excp",
    "description": "Campaign example",
    "dateStart": "2015-01-01T00:00:00",
    "deadline": "2015-09-04T00:00:00",
    "responsibleID": "00000000-0000-0000-0000-000000000000",
    "campaignMetaproperties": "00000000-0000-0000-0000-000000000000"
  }
}

Update Collection

Edit an existing collection | key: updateCollection

Input	Notes	Example
Connection
Collection Description	The description of the collection to create	Extended asset description
Collection ID	The ID of the collection to update	00000000-0000-0000-0000000000000000
Is Public	Indicates whether or not to treat the itemId as a hashed item id	true
Collection Name	The name of the collection to create	Asset Name

{
  "data": {
    "message": "Created",
    "statuscode": 201
  }
}

Update Job

Edit an existing job | key: updateJob

Input	Notes	Example
Accountable ID	Id of the user responsible for the job	00000000-0000-0000-0000000000000000
Data	Additional data to update the job
Campaign ID	Id of the campaign the job is part of	00000000-0000-0000-0000000000000000
Connection
Description	The description of the job	Extended asset description
Job ID	The ID of the job to update	00000000-0000-0000-0000000000000000
Name	The name of the job	Asset Name

{
  "data": {
    "status": "Created",
    "job_id": "00000000-0000-0000-0000-000000000000"
  }
}

Update Order

Update an existing order | key: updateOrder

Input	Notes	Example
Connection
Order ID	The ID of the order to update	00000000-0000-0000-0000000000000000
Message	A message	Order has been delivered
Order Status	Status of the order
Tracking Number	Link to trackingnumber	trackingnumber

{
  "data": {
    "message": "Created",
    "statuscode": 201
  }
}

Update User

Edit an existing user | key: updateUser

Input	Notes	Example
Data	Extra fields to be included in the request. Must be valid JSON.
Connection
Email	Email address for login.	test@test.com
First Name	First name of the user.	John
ID	The ID of the user to update	00000000-0000-0000-0000000000000000
Last Name	Last name of the user.	Doe
Password	Password for login.	password
Profile ID	Security profile id for determining the user's rights. Can be retrieved by using the Retrieve security profiles call.	00000000-0000-0000-0000000000000000
Username	Username for login. If not defined it will take your email as username.	user123

{
  "data": {
    "id": "00000000-0000-0000-0000000000000000",
    "username": "user123"
  }
}

Upload Chunk

Upload a chunk of a file. | key: uploadChunk

Input	Notes	Example
Chunk	Chunk index number (indexing starts from 1).
Chunks	Total number of chunks.
File	File or chunk of the file to be uploaded.
Multipart Parameters	Parameters for the multipart upload. Use all the fields from the response of the initialise upload call.
Upload URL	Amazon upload endpoint received from calling Get closest AmazonS3 upload endpoint.	https://bynder-public-eu-central-1.s3.amazonaws.com/

{
  "data": {
    "PostResponse": {
      "Location": [
        "https://bynder-public-us-east-1.s3.amazonaws.com/pluploads%2Fa9db39d8-ff60-4292-b189-97f81213bb69%2FpdfValue.pdf"
      ],
      "Bucket": [
        "bynder-public-us-east-1"
      ],
      "Key": [
        "pluploads/a9db39d8-ff60-4292-b189-97f81213bb69/pdfValue.pdf"
      ],
      "ETag": [
        "\"1c32d785398e3a7eaab0e9b876903cc6\""
      ]
    },
    "filename": "api_uploads/00000000-0000-0000-0000000000000000/00000000-0000-0000-0000000000000000/Logo.png/p5"
  }
}

Changelog

2026-03-05

Added inline data sources for assets, brands, orders, users, security profiles, and metaproperties to enhance data selection capabilities

Bynder is a leading digital asset management software that allows users to easily create, find, and use content, such as documents, graphics, and videos.

Description​

API Documentation​

Connections​

OAuth 2.0 Client Credentials​

Prerequisites​

Setup Steps​

Configure the Connection​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Data Sources​

Select Asset​

Select Brand​

Select Campaign​

Select Collection​

Select Job​

Select Metaproperty​

Select Order​

Select Security Profile​

Select User​

Actions​

Add Asset Metaproperty Options​

Close Campaign​

Create Campaign​

Create Collection​

Create Job​

Create User​

Delete Asset​

Delete Asset Metaproperty Options​

Delete Campaign​

Delete Collection​

Delete Job​

Delete User​

Download Specific Asset Item​

Finalize Complete Upload​

Finalize Complete Upload And Save As New Asset Additional​

Generate Dynamic Asset Transformation​

Get Account Information​

Get Asset​

Get Campaign​

Get Closest S3 Upload Endpoint​

Get Collection​

Get Current User​

Get Job​

Get Job Preset​

Get Media of Job​

Get Order​

Get Order Info​

Get Security Profile​

Get User​

Initialize Upload​

List Assets​

List Brands​

List Campaigns​

List Collections​

List Jobs​

List Jobs By Campaign​

List Metaproperties​

List Orders​

List Security Profiles​

List Users​

Raw Request​

Register Uploaded Chunk​

Retrieve Poll State​

Save a New Asset​

Save as a New Asset Version​

Share Collection​

Update Asset​

Update Campaign​

Update Collection​

Update Job​

Update Order​

Update User​

Upload Chunk​

Changelog​

2026-03-05​

Description

API Documentation

Connections

OAuth 2.0 Client Credentials

Prerequisites

Setup Steps

Configure the Connection

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Data Sources

Select Asset

Select Brand

Select Campaign

Select Collection

Select Job

Select Metaproperty

Select Order

Select Security Profile

Select User

Actions

Add Asset Metaproperty Options

Close Campaign

Create Campaign

Create Collection

Create Job

Create User

Delete Asset

Delete Asset Metaproperty Options

Delete Campaign

Delete Collection

Delete Job

Delete User

Download Specific Asset Item

Finalize Complete Upload

Finalize Complete Upload And Save As New Asset Additional

Generate Dynamic Asset Transformation

Get Account Information

Get Asset

Get Campaign

Get Closest S3 Upload Endpoint

Get Collection

Get Current User

Get Job

Get Job Preset

Get Media of Job

Get Order

Get Order Info

Get Security Profile

Get User

Initialize Upload

List Assets

List Brands

List Campaigns

List Collections

List Jobs

List Jobs By Campaign

List Metaproperties

List Orders

List Security Profiles

List Users

Raw Request

Register Uploaded Chunk

Retrieve Poll State

Save a New Asset

Save as a New Asset Version

Share Collection

Update Asset

Update Campaign

Update Collection

Update Job

Update Order

Update User

Upload Chunk

Changelog

2026-03-05