Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Create group
All
Pages
Start typing to search…
JUMP TO
OAuth 2.0
Authorize endpoint
Authorize endpoint
get
Token endpoint
Using an authorization code
post
Using a refresh token
post
Using client credentials
post
Scopes
Retrieve scopes
get
Retrieve scopes
get
Security Roles
Profiles
Retrieve security profiles
get
Retrieve specific security profile
get
Users
Users
Retrieve users
get
Create user
post
Users ID
Retrieve specific user
get
Modify user
post
Delete user
del
Current User
Retrieve current user
get
Groups
Groups
Retrieve groups
get
Download API
Media download
Retrieve asset download location
get
Retrieve asset version download location
get
Retrieve specific asset item download location
get
Analytics API
Asset Usage V2
Retrieve asset views
get
Asset Usage V1
Retrieve asset view events
get
Retrieve asset download events
get
Retrieve asset download events
get
Retrieve asset creation events
get
Retrieve asset archive events
get
Retrieve removed asset events
get
Retrieve all events performed in a given asset
get
Search Usage
Retrieve search execution events
get
Retrieve search keyword events
get
Retrieve search keyword events in CSV format
get
User Usage
User Login
get
User Activity
get
Collection Usage
Retrieve collection view events
get
Retrieve collection view events in CSV format
get
Reporting
Retrieve asset reports
get
Retrieve specific asset report
get
Historical Data
Retrieve historical data in CSV format
get
Smartfilters API
Smartfilters
Retrieve smartfilters
get
Tags API
Tags
Retrieve tags
get
Add tag to assets
post
Remove tag from assets
del
Access Rights API
Access rights
Retrieve metaproperty access
get
Create metaproperty access
post
Delete metaproperty access
del
Asset Usage API
Asset Usage
Retrieve asset usage
get
Create asset usage
post
Delete asset usage
del
Asset Usage Sync
Sync asset usage
post
Account API
Account
Retrieve account information
get
Retrieve derivatives
get
Collections API
Collections
Retrieve collections
get
Create collection
post
Collections ID
Retrieve specific collection
get
Modify collection
post
Delete collection
del
Share collection
Share collection
post
Collections assets
Retrieve the assets of a specific collection
get
Add assets to a collection
post
Remove assets from a collection
del
Trash API
Trash
Retrieve recently removed assets
get
Workflow Users and Groups API
Users
Retrieve users
get
Retrieve specific user
get
Groups
Retrieve groups
get
Create group
post
Retrieve specific group
get
Modify group
put
Delete group
del
Workflow Metaproperties API
Metaproperties
Retrieve metaproperties
get
Retrieve specific metaproperty
get
Workflow Campaigns API
Campaigns
Retrieve campaigns
get
Create campaign
post
Retrieve specific campaign
get
Modify campaign
put
Delete campaign
del
Close campaign
post
Product Layer Metaproperties API
Metaproperties
Retrieve metaproperties
get
Retrieve specific metaproperty
get
Options
Retrieve metaproperty options
get
Modify metaproperty option
put
Brands
/api/v4/brands/
Retrieve brands
get
/api/1/assets/similarity-search/
Dynamic Asset Transformations API
/transform/{id}/{name}
Generate dynamic asset transformation
get
Metaproperty Operations
Metaproperty operations
Retrieve metaproperties
get
Create metaproperty
post
Specific metaproperty operations
Retrieve specific metaproperty
get
Modify metaproperty
post
Delete metaproperty
del
Metaproperty Options and Operations API
Metaproperty options operations
Retrieve metaproperty options by ids
get
Retrieve metaproperty options
get
Create metaproperty option
post
Specific metaproperty option operations
Modify metaproperty option
post
Delete metaproperty option
del
Retrieve all metaproperty option dependencies globally
Retrieve global option dependencies
get
Retrieve all metaproperty option dependencies for a metaproperty
Retrieve metaproperty option dependencies
get
Retrieve options a metaproperty option depends on
Retrieve specific metaproperty option dependencies
get
Manage ungrouped metaproperty option dependencies
Add a dependency
post
Delete a dependency
del
Create metaproperty option dependency group
Create dependency group
post
Specific metaproperty option dependency group operations
Modify dependency group
post
Manage option dependency in dependency group
Add a dependency option to a group
post
Remove a dependency option from a group
del
TEA - Public API
document
getDocument
get
Modern Stack File Upload
Step 1
Prepare the upload
post
Step 2
Upload a file chunk
post
Step 3
Finalize the upload
post
Taxonomy
Options V1
/api/1/taxonomy/metaproperties/{metapropertyId}/options
get
Derivative Presets API
/api/1/derivative-presets/
Retrieve all configured derivative presets.
get
/api/1/derivative-presets/{preset_id}
Retrieve a specific configured derivative preset.
get
automation-workflow-svc API
Automation Workflow Rules
Fetches all automation workflow rules.
get
Create Automation Workflow Rule
post
Fetches a automation workflow rule.
get
Edit Automation Workflow Rule
put
Remove Automation Workflow Rule
del
Update Automation Workflow Rule Status
patch
Automation Workflow Triggers
List Automation Workflow Triggers
get
Automation Workflow Conditions
List Automation Workflow Conditions
get
Automation Workflow Actions
List Automation Workflow Actions
get
Metaproperty Options and Operations API TEST
Metaproperty options operations
Retrieve metaproperty options (New)
get
Retrieve metaproperty options by ids
get
Retrieve metaproperty options
get
Create metaproperty option
post
Specific metaproperty option operations
Modify metaproperty option
post
Delete metaproperty option
del
Retrieve all metaproperty option dependencies globally
Retrieve global option dependencies
get
Retrieve all metaproperty option dependencies for a metaproperty
Retrieve metaproperty option dependencies
get
Retrieve options a metaproperty option depends on
Retrieve specific metaproperty option dependencies
get
Manage ungrouped metaproperty option dependencies
Add a dependency
post
Delete a dependency
del
Create metaproperty option dependency group
Create dependency group
post
Specific metaproperty option dependency group operations
Modify dependency group
post
Manage option dependency in dependency group
Add a dependency option to a group
post
Remove a dependency option from a group
del
Workflow Jobs API
Presets
Retrieve specific job preset
get
Jobs
Retrieve jobs
get
Create job
post
Retrieve specific job
get
Modify job
put
Delete job
del
Campaign jobs
Retrieve the jobs of a specific campaign
get
Job media
Retrieve media of specific job
get
File upload
Upload a file to a workflow job
post
Finish
Finish job
patch
Job stages
Retrieve stages of specific job
get
Antivirus API
Quarantine
Retrieve a list of quarantined assets
get
Retrieve a quarantined asset by id
get
Update review status by id
put
Update review status by list of asset Ids
post
Brandstore API
Orders
Retrieve orders
get
Retrieve specific order info
get
Retrieve specific order by id
get
Modify order
post
Retrieve specific orderline
get
Modify orderline
patch
Webhooks API
Configurations
Retrieve a Webhook Configuration
get
Create a Webhook Configuration
post
Update a Webhook Configuration
put
Patch a Webhook Configuration
patch
Delete a Webhook Configuration
del
Group Upload Assets API Steps
Step 1 Get closest AmazonS3 upload endpoint
Get closest Amazon S3 upload endpoint
get
Step 2 Initialise upload
Initialise upload
post
Step 3A Upload file in chunks
Upload file in chunks
post
Step 3B Register uploaded chunk
Register uploaded chunk
post
Step 4 EITHER Finalise uploaded file
Finalise an uploaded file
post
Step 4 OR Finalize and save an additional uploaded file as a new asset.
Finalize additional file
post
Step 5 Poll for processing status
Retrieve poll state
get
Step 6 EITHER Save as a new asset
Save as a new asset
post
Step 6 OR Save uploaded file to existing asset
Save uploaded file to existing asset
post
Asset Management API
Media
Retrieve assets
get
Media ID
Retrieve specific asset
get
Modify asset
post
Delete asset
del
Media options
Add metaproperty options
post
Delete metaproperty options
del
Access Rights and Optiops API
Access rights
Retrievemetapropertyaccess
get
Createmetapropertyaccess
post
Deletemetapropertyaccess
del
Options
Retrieve Option Access Rights
get
Modify Option Access Rights
put
Retrieve Option Default Visibility
get
Modify Option Default Visibility
put
Adaptive Video Streaming API
Public links
Get public links for an asset
get
Similar Assets Search API
Search
Search for similar assets
post
Powered by
Create group
Ask AI
post
https://{your-bynder-domain}/api/workflow/groups/
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
URL
Base URL
https://
your-bynder-domain
/api/workflow/groups/
Response
Click
Try It!
to start a request and see the response here!