# Bynder API Documentation

> Documentation for Bynder API

## Guides: Documentation
- [Getting Started with Bynder API](https://api.bynder.com/docs/getting-started.md): This page will help you get started with Bynder API. You'll be up and running in a jiffy!

## API Reference: OAuth 2.0
- [Authorize endpoint](https://api.bynder.com/reference/authorize-endpoint.md)
  - [Authorize endpoint](https://api.bynder.com/reference/get_v6-authentication-oauth2-auth.md): 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…
- [Token endpoint](https://api.bynder.com/reference/token-endpoint.md)
  - [Using an authorization code](https://api.bynder.com/reference/post_v6-authentication-oauth2-token-authorization.md): Use the token endpoint to retrieve an access token which can be used to authorize API requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials…
  - [Using a refresh token](https://api.bynder.com/reference/post_v6-authentication-oauth2-token-refresh.md): Use the token endpoint to retrieve an access token which can be used to authorize API requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials…
  - [Using client credentials](https://api.bynder.com/reference/post_v6-authentication-oauth2-token-client-credentials.md): Use the token endpoint to retrieve an access token which can be used to authorize API requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials…
- [Scopes](https://api.bynder.com/reference/scopes.md)
  - [Retrieve scopes](https://api.bynder.com/reference/get_v6-authentication-oauth2-scopes.md): Retrieve a JSON formatted overview of the existing scopes within Bynder and the required user permissions.

## API Reference: Security Roles
- [Profiles](https://api.bynder.com/reference/profiles.md)
  - [Retrieve security profiles](https://api.bynder.com/reference/get_api-v4-profiles.md): 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…
  - [Retrieve specific security profile](https://api.bynder.com/reference/get_api-v4-profiles-id.md): 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…

## API Reference: Users
- [Users](https://api.bynder.com/reference/users.md)
  - [Retrieve users](https://api.bynder.com/reference/get_api-v4-users.md)
  - [Create user](https://api.bynder.com/reference/post_api-v4-users.md)
- [Users ID](https://api.bynder.com/reference/users-id.md)
  - [Retrieve specific user](https://api.bynder.com/reference/get_api-v4-users-id.md)
  - [Modify user](https://api.bynder.com/reference/post_api-v4-users-id.md)
  - [Delete user](https://api.bynder.com/reference/delete_api-v4-users-id.md)
- Current User
  - [Retrieve current user](https://api.bynder.com/reference/get_api-v4-currentuser.md): Retrieve the current user information. Unlike [Retrieve specific user](#reference/users/specific-user-operations/retrieve-specific-user) this call doesn't require you to know your user id in order to…

## API Reference: Account API
- [Account](https://api.bynder.com/reference/account.md)
  - [Retrieve account information](https://api.bynder.com/reference/get_api-v4-account.md)
  - [Retrieve derivatives](https://api.bynder.com/reference/get_api-v4-account-derivatives.md): 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…

## API Reference: Groups
- [Groups (Preferred)](https://api.bynder.com/reference/groups-preferred.md)
  - [List groups](https://api.bynder.com/reference/listgroups.md): Returns a paginated list of groups with member count.  Requires the **GROUPMANAGEMENT** security role.
  - [Create a group](https://api.bynder.com/reference/creategroup.md): Creates a new group.  Requires the **GROUPMANAGEMENT** security role.
  - [Get group by ID](https://api.bynder.com/reference/getgroup.md): Returns a single group by its ID, including member count.  Requires the **GROUPMANAGEMENT** security role.
  - [Update a group](https://api.bynder.com/reference/updategroup.md): Updates the name and/or description of an existing group.  At least one field must be provided. Only the fields included in the request body are updated (partial update semantics).  Requires the…
  - [Delete a group](https://api.bynder.com/reference/deletegroup.md): Deletes a group and removes all its members from it.  Requires the **GROUPMANAGEMENT** security role.
  - [Add users to a group](https://api.bynder.com/reference/adduserstogroup.md): Adds one or more users to the specified group. Pass a single-element array to add one user.  Users that are already members of the group are silently ignored (the operation is idempotent). An empty…
  - [Remove users from a group](https://api.bynder.com/reference/removeusersfromgroup.md): Removes one or more users from the specified group. Pass a single-element array to remove one user.  Users not currently in the group are silently ignored (the operation is idempotent). An empty…
- [Groups (Legacy)](https://api.bynder.com/reference/groups-legacy.md)
  - [Retrieve groups](https://api.bynder.com/reference/retrievegroupslegacy.md): Requires the **GROUPMANAGEMENT** security role.

## API Reference: Asset Usage API
- [Asset Usage](https://api.bynder.com/reference/asset-usage.md)
  - [Retrieve asset usage](https://api.bynder.com/reference/get_api-media-usage.md): Retrieve asset usage information.
  - [Create asset usage](https://api.bynder.com/reference/post_api-media-usage.md): Create a new asset usage entry.
  - [Delete asset usage](https://api.bynder.com/reference/delete_api-media-usage.md): Delete an asset usage entry.
- [Asset Usage Sync](https://api.bynder.com/reference/asset-usage-sync.md)
  - [Sync asset usage](https://api.bynder.com/reference/post_api-media-usage-sync.md): Sync all usage from a single integration.

## API Reference: Asset Management API
- [Media](https://api.bynder.com/reference/media.md)
  - [Retrieve assets](https://api.bynder.com/reference/get_api-v4-media.md): `original` is only returned for assets marked as public and requires the account to have the `seoBaseUrl` setting configured.
- [Media ID](https://api.bynder.com/reference/media-id.md)
  - [Retrieve specific asset](https://api.bynder.com/reference/get_api-v4-media-id.md): Requires the **STATISTICS** security role in order to retrieve *views* and *downloads* statistics data in the response, using the `stats` parameter.
  - [Modify asset](https://api.bynder.com/reference/post_api-v4-media-id.md): Requires the **MEDIAEDIT** security role. Requires the **MARKPUBLIC** security role in order to change an asset's isPublic state.  **Custom thumbnails**  To set a custom thumbnail, first upload the…
  - [Delete asset](https://api.bynder.com/reference/delete_api-v4-media-id.md): Requires the **MEDIAREMOVE** security role.
- [Media options](https://api.bynder.com/reference/media-options.md)
  - [Add metaproperty options](https://api.bynder.com/reference/post_api-media-options.md): These calls allow you to change the metaproperty options attached to an asset.  **Note that this is an append operation; the options you add here will be appended to the existing option on the asset,…
  - [Delete metaproperty options](https://api.bynder.com/reference/delete_api-media-options.md)

## API Reference: Asset API (Beta)
- [Asset ingestion](https://api.bynder.com/reference/asset-ingestion.md): Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of…
  - [Create asset](https://api.bynder.com/reference/postapi1assetassets.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Create upload url](https://api.bynder.com/reference/postapi1assetassetsassetidupload-url.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Upload file initialization](https://api.bynder.com/reference/postuploadurlinitialization.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Upload file chunks](https://api.bynder.com/reference/patchuploadfilechunks.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Publish](https://api.bynder.com/reference/postapi1assetassetsassetidpublish.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
- [Asset enrichment](https://api.bynder.com/reference/asset-enrichment.md): Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.  > **Note:** This API is subject to change until it reaches…
  - [Edit asset](https://api.bynder.com/reference/patchapi1assetassetsassetid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Get asset metaproperties](https://api.bynder.com/reference/getapi1assetassetsassetidmetaproperties.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Set asset metaproperties](https://api.bynder.com/reference/putapi1assetassetsassetidmetaproperties.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Update individual asset metaproperty](https://api.bynder.com/reference/putapi1assetassetsassetidmetapropertiesmetapropertyid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Delete individual asset metaproperty](https://api.bynder.com/reference/deleteapi1assetassetsassetidmetapropertiesmetapropertyid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Set tags](https://api.bynder.com/reference/putapi1assetassetsassetidtags.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Create embargo](https://api.bynder.com/reference/postapi1assetassetsassetidembargos.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Update embargo](https://api.bynder.com/reference/putapi1assetassetsassetidembargosembargoid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Delete embargo](https://api.bynder.com/reference/deleteapi1assetassetsassetidembargosembargoid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Update advanced right](https://api.bynder.com/reference/patchapi1assetassetsassetidadvanced-rights.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Set autotags](https://api.bynder.com/reference/putapi1assetassetsassetidautotags.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Set asset relations](https://api.bynder.com/reference/putapi1assetassetsassetidrelationsrelationid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Get asset relations](https://api.bynder.com/reference/getapi1assetassetsassetidrelations.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Add asset relations](https://api.bynder.com/reference/postapi1assetassetsassetidrelationsrelationid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Remove asset relations](https://api.bynder.com/reference/deleteapi1assetassetsassetidrelationsrelationid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
- [General endpoints](https://api.bynder.com/reference/general-endpoints.md): Retrieve, validate, and manage existing assets and their versions.
  - [Get asset](https://api.bynder.com/reference/getapi1assetassetsassetid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Delete asset](https://api.bynder.com/reference/deleteapi1assetassetsassetid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Get version](https://api.bynder.com/reference/getapi1assetassetsassetidversionsversionid.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Get the active asset version thumbnails](https://api.bynder.com/reference/getapi1assetassetsassetidthumbnails.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…
  - [Validate asset](https://api.bynder.com/reference/getapi1assetassetsassetidvalidate.md): > **IMPORTANT NOTE** > These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets…

## API Reference: Modern Stack File Upload
- Step 1
  - [Prepare the upload](https://api.bynder.com/reference/post_v7-file-cmds-upload-prepare.md): Prepare the upload of a file in chunks.
- Step 2
  - [Upload a file chunk](https://api.bynder.com/reference/post_v7-file-cmds-upload-file-id-chunk-chunk-number.md): Upload a chunk of the file.
- Step 3
  - [Finalize the upload](https://api.bynder.com/reference/post_v7-file-cmds-upload-file-id-finalise-api.md): Finalize the upload after all chunks have been uploaded.

## API Reference: Upload Assets API
- Step 1 Get closest AmazonS3 upload endpoint
  - [Get closest Amazon S3 upload endpoint](https://api.bynder.com/reference/get-closest-amazon-s3-upload-endpoint.md): Get the closest AmazonS3 upload endpoint.
- Step 2 Initialise upload
  - [Initialise upload](https://api.bynder.com/reference/initialiseupload-1.md): Initialise an upload.
- Step 3A Upload file in chunks
  - [Upload file in chunks](https://api.bynder.com/reference/upload-file-in-chunks.md): Uploading a file consists of the following two parts:  **1. Breaking down your file into parts/chunks**  Each part must be at least 5 MB in size, except for the last part. There is no size limit on…
- Step 3B Register uploaded chunk
  - [Register uploaded chunk](https://api.bynder.com/reference/register-uploaded-chunk.md): Register the completion of an uploaded chunk.
- Step 4 EITHER Finalise uploaded file
  - [Finalise an uploaded file](https://api.bynder.com/reference/finalise-an-uploaded-file.md): The endpoints described in Step 4 are an Either/Or choice. You should use either the `Finalise an uploaded file` endpoint to finalize and process a standard upload, or the `Finalize additional file`…
- Step 4 OR Finalize and save an additional uploaded file as a new asset.
  - [Finalize additional file](https://api.bynder.com/reference/finalize-additional-file.md): The endpoints described in Step 4 are an Either/Or choice. You should use either the `Finalise an uploaded file` endpoint to finalize and process a standard upload, or the `Finalize additional file`…
- Step 5 Poll for processing status
  - [Retrieve poll state](https://api.bynder.com/reference/retrieve-poll-state.md): This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the **items** parameter.
- Step 6 EITHER Save as a new asset
  - [Save as a new asset](https://api.bynder.com/reference/saveasanewasset-1.md): For metaproperties that use options (Select, Select2, Autocomplete), modifying an asset's metaproperty options should be done via option UUID's for the API to work optimally, sending name or label…
- Step 6 OR Save uploaded file to existing asset
  - [Save uploaded file to existing asset](https://api.bynder.com/reference/save-uploaded-file-to-existing-asset.md): Be aware that the endpoints described in Step 6 are an Either/Or choice. You should use either the `Save as a new asset` endpoint to save the uploaded file as a new asset, or the `Update existing…

## API Reference: Similar Assets Search API
- Search
  - [Search for similar assets](https://api.bynder.com/reference/post_api-1-assets-similarity-search.md): Perform a similarity search for assets based on asset IDs, image URL, image data, or text query. <br><br>This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase.…

## API Reference: Dynamic Asset Transformations API
- /transform/{id}/{name}
  - [Generate dynamic asset transformation](https://api.bynder.com/reference/get_transform-id-name.md): 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…

## API Reference: Collections API
- [Collections](https://api.bynder.com/reference/collections.md)
  - [Retrieve collections](https://api.bynder.com/reference/get_api-v4-collections.md): Retrieve a list of collections.
  - [Create collection](https://api.bynder.com/reference/post_api-v4-collections.md): Create a new collection.
- [Collections ID](https://api.bynder.com/reference/collections-id.md)
  - [Retrieve specific collection](https://api.bynder.com/reference/get_api-v4-collections-id.md): Retrieve a specific collection by ID.
  - [Modify collection](https://api.bynder.com/reference/post_api-v4-collections-id.md): Modify a specific collection by ID.
  - [Delete collection](https://api.bynder.com/reference/delete_api-v4-collections-id.md): Delete a specific collection by ID.
- [Share collection](https://api.bynder.com/reference/share-collection.md)
  - [Share collection](https://api.bynder.com/reference/post_api-v4-collections-id-share.md): Share a specific collection by ID.
- [Collections assets](https://api.bynder.com/reference/collections-assets.md)
  - [Retrieve the assets of a specific collection](https://api.bynder.com/reference/get_api-v4-collections-id-media.md): Retrieve the assets of a specific collection by ID.
  - [Add assets to a collection](https://api.bynder.com/reference/post_api-v4-collections-id-media.md): Add assets to a specific collection by ID.
  - [Remove assets from a collection](https://api.bynder.com/reference/delete_api-v4-collections-id-media.md): Remove assets from a specific collection by ID.

## API Reference: Download API
- [Media download](https://api.bynder.com/reference/media-download.md)
  - [Retrieve asset download location](https://api.bynder.com/reference/get_api-v4-media-id-download.md): Retrieve the download location for an asset. __Warning:__ Requires the MEDIAHIGHRES security role. __Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.…
  - [Retrieve asset version download location](https://api.bynder.com/reference/get_api-v4-media-id-version-download.md): Retrieve the download location for a specific asset version. __Warning:__ Requires the MEDIAHIGHRES security role. __Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is…
  - [Retrieve specific asset item download location](https://api.bynder.com/reference/get_api-v4-media-id-download-itemid.md): Retrieve the download location for a specific asset item. __Warning:__ Requires the MEDIAHIGHRES security role. __Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is…

## API Reference: Metaproperty
- [Metaproperties - New API (Preferred)](https://api.bynder.com/reference/metaproperties-new-api-preferred.md)
  - [Retrieve metaproperties](https://api.bynder.com/reference/getapi1taxonomymetaproperties.md): Returns a paginated list of metaproperties.  The /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for…
  - [Create metaproperty](https://api.bynder.com/reference/postapi1taxonomymetaproperties.md): Create a new metaproperty
  - [Retrieve Metaproperty](https://api.bynder.com/reference/getapi1taxonomymetapropertiesmetapropertyid.md): Retrieve a single metaproperty by its id.  The /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for…
  - [Modify metaproperty](https://api.bynder.com/reference/patchapi1taxonomymetapropertiesmetapropertyid.md): Modify a metaproperty by id
  - [Delete metaproperty](https://api.bynder.com/reference/deleteapi1taxonomymetapropertiesmetapropertyid.md): Delete a metaproperty by id
- [Metaproperties - Old API (Please use new API if possible)](https://api.bynder.com/reference/metaproperties-old-api-please-use-new-api-if-possible.md)
  - [Retrieve metaproperties](https://api.bynder.com/reference/get_api-v4-metaproperties.md)
  - [Create metaproperty](https://api.bynder.com/reference/post_api-v4-metaproperties.md): Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
  - [Retrieve metaproperty](https://api.bynder.com/reference/get_api-v4-metaproperties-id.md)
  - [Modify metaproperty](https://api.bynder.com/reference/post_api-v4-metaproperties-id.md): Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
  - [Delete metaproperty](https://api.bynder.com/reference/delete_api-v4-metaproperties-id.md): Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

## API Reference: Metaproperty options
- [Options - New API (Preferred)](https://api.bynder.com/reference/options-new-api-preferred.md)
  - [Retrieve options for a metaproperty](https://api.bynder.com/reference/getapi1taxonomymetapropertiesmetapropertyidoptions.md): The /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for read-only operations. These endpoints do not…
  - [Create option](https://api.bynder.com/reference/postapi1taxonomymetapropertiesmetapropertyidoptions.md): Create a new option
  - [Modify option](https://api.bynder.com/reference/patchapi1taxonomymetapropertiesmetapropertyidoptionsoptionid.md): Modify an option by id
  - [Delete option](https://api.bynder.com/reference/deleteapi1taxonomymetapropertiesmetapropertyidoptionsoptionid.md): Delete an option by id
- [Options - Old API (Please use new API if possible)](https://api.bynder.com/reference/options-old-api-please-use-new-api-if-possible.md)
  - [Retrieve options by ids](https://api.bynder.com/reference/get_api-v4-metaproperties-options.md)
  - [Retrieve options for a metaproperty](https://api.bynder.com/reference/get_api-v4-metaproperties-id-options.md)
  - [Create option](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options.md): Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.  Note: when the `name` you provide differs from the option's label, Bynder automatically assigns that `name` value as the option's…
  - [Modify option](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid.md): Modify a specific option.
  - [Delete option](https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid.md)

## API Reference: Automations API
- [Automations - New taxonomy API](https://api.bynder.com/reference/automations-new-taxonomy-api.md)
  - [Retrieve automations](https://api.bynder.com/reference/getapi1automationautomations.md): Filter automations by metaproperty actions. Requires a `metaproperty_id`, optionally accepts one or more comma separated `option_ids`.
  - [Create automation](https://api.bynder.com/reference/postapi1automationautomations.md): Create a new automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.
  - [Retrieve automation by id](https://api.bynder.com/reference/getapi1automationautomationsautomationid.md): Retrieve a single automation by its unique id.
  - [Modify automation](https://api.bynder.com/reference/putapi1automationautomationsautomationid.md): Modify an automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.
  - [Delete automation](https://api.bynder.com/reference/deleteapi1automationautomationsautomationid.md): Delete an automation by id.

## API Reference: Dependencies for Metaproperties and Options
- [Option dependency (Please use new Automations API if possible)](https://api.bynder.com/reference/option-dependency.md)
  - [Retrieve global option dependencies](https://api.bynder.com/reference/get_api-v4-metaproperties-options-dependencies.md): Retrieve all metaproperty option dependencies globally.
  - [Retrieve option dependencies for a metaproperty](https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-dependencies.md): Retrieve all metaproperty option dependencies for a specific metaproperty.
  - [Retrieve dependencies for a metaproperty option](https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-optionid-dependencies.md): Retrieve dependencies for a metaproperty option.
  - [Add a dependency](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-dependencyid.md): Manage metaproperty option dependencies
  - [Delete a dependency](https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid-dependencies-dependencyid.md): Delete a dependency from a metaproperty option.
- [Option dependency group (Please use new Automations API if possible)](https://api.bynder.com/reference/option-dependency-group.md)
  - [Create dependency group](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group.md): Create a dependency group for a metaproperty option.
  - [Modify dependency group](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid.md): Modify a dependency group for a metaproperty option.
  - [Add a dependency option to a group](https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid-dependencyid.md): Add a dependency option to a specific dependency group for a metaproperty option.
  - [Remove a dependency option from a group](https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid-dependencyid.md): Remove a dependency option from a specific dependency group for a metaproperty option.

## API Reference: Tags API
- [Tags](https://api.bynder.com/reference/tags.md)
  - [Retrieve tags](https://api.bynder.com/reference/get_api-v4-tags.md): Retrieve a list of tags.
  - [Add tag to assets](https://api.bynder.com/reference/post_api-v4-tags-id-media.md): Add a tag to a list of assets.
  - [Remove tag from assets](https://api.bynder.com/reference/delete_api-v4-tags-id-media.md): Remove a tag from a list of assets.

## API Reference: Smartfilters API
- [Smartfilters](https://api.bynder.com/reference/smartfilters.md)
  - [Retrieve smartfilters](https://api.bynder.com/reference/get_api-v4-smartfilters.md): Retrieve a list of smartfilters.

## API Reference: Access Rights and Options API
- [Access rights](https://api.bynder.com/reference/access-rights-1.md)
  - [Retrieve metaproperty access](https://api.bynder.com/reference/retrieve-metaproperty-access.md)
  - [Create metaproperty access](https://api.bynder.com/reference/create-metaproperty-access.md)
  - [Delete metaproperty access](https://api.bynder.com/reference/delete-metaproperty-access.md)
- [Options](https://api.bynder.com/reference/options-1.md)
  - [Retrieve Option Access Rights](https://api.bynder.com/reference/get_api-1-content-access-options-optionid.md)
  - [Modify Option Access Rights](https://api.bynder.com/reference/put_api-1-content-access-options-optionid.md)
  - [Retrieve Option Default Visibility](https://api.bynder.com/reference/get_api-1-content-access-options-optionid-visibility.md)
  - [Modify Option Default Visibility](https://api.bynder.com/reference/put_api-1-content-access-options-optionid-visibility.md)

## API Reference: Trash API
- [Trash](https://api.bynder.com/reference/trash.md)
  - [Retrieve recently removed assets](https://api.bynder.com/reference/get_api-trash-media.md): Retrieve assets removed in the last 30 days.

## API Reference: Workflow Jobs API
- [Presets](https://api.bynder.com/reference/presets.md)
  - [Retrieve specific job preset](https://api.bynder.com/reference/get_api-workflow-presets-job-id.md)
- [Jobs](https://api.bynder.com/reference/jobs.md)
  - [Retrieve jobs](https://api.bynder.com/reference/get_api-workflow-jobs.md)
  - [Create job](https://api.bynder.com/reference/post_api-workflow-jobs.md): Requires the JOBADD security role.
  - [Retrieve specific job](https://api.bynder.com/reference/get_api-workflow-jobs-id.md): Requires the JOBOVERVIEW security role.
  - [Modify job](https://api.bynder.com/reference/put_api-workflow-jobs-id.md): Requires the JOBEDIT security role. Note: `responsibleID` and `responsibleGroupID` cannot be set on `previousStage`, `activeStage`, or `nextStage` through this endpoint. To update a stage's…
  - [Delete job](https://api.bynder.com/reference/delete_api-workflow-jobs-id.md): Requires the JOBREMOVE security role.
- [Campaign jobs](https://api.bynder.com/reference/campaign-jobs.md)
  - [Retrieve the jobs of a specific campaign](https://api.bynder.com/reference/get_api-workflow-campaigns-id-jobs.md): Requires the CAMPAIGNOVERVIEW security role.
- [Job media](https://api.bynder.com/reference/job-media.md)
  - [Retrieve media of specific job](https://api.bynder.com/reference/get_api-workflow-jobs-id-media.md): Requires the JOBOVERVIEW security role.
- [File upload](https://api.bynder.com/reference/file-upload.md)
  - [Upload a file to a workflow job](https://api.bynder.com/reference/post_api-workflow-jobs-id-upload.md): To upload a file to a workflow job it needs to be uploaded via the Upload file endpoint for modern stack. After completing the various steps described in the Upload file endpoint, the `fileId`…
- [Stages](https://api.bynder.com/reference/stages.md)
  - [Update stage](https://api.bynder.com/reference/put_api-workflow-stages-id.md): Requires the JOBEDIT security role. Updates a workflow stage, including the user or group responsible for it (displayed as Responsible in the UI).
- [Finish](https://api.bynder.com/reference/finish.md)
  - [Finish job](https://api.bynder.com/reference/patch_api-workflow-jobs-id-finish.md): Requires the JOBAPPROVE security role.
- [Job stages](https://api.bynder.com/reference/job-stages.md)
  - [Retrieve stages of specific job](https://api.bynder.com/reference/get_api-workflow-jobs-id-stages.md): Requires the JOBOVERVIEW security role.

## API Reference: Automation Workflow API
- [Automation Workflow Rules](https://api.bynder.com/reference/automation-workflow-rules.md)
  - [Fetches all automation workflow rules.](https://api.bynder.com/reference/getrules.md): Fetches all automation workflow rules within an account in descending order of creation, with optional pagination (start and limit).
  - [Creates a new automation workflow rule.](https://api.bynder.com/reference/postrules.md): Creates a new automation workflow rule. Ensure that you check the available triggers, conditions, and actions to use valid options.  Use the following endpoints to check which options are available…
  - [Fetches a specific automation workflow rule.](https://api.bynder.com/reference/getrulesruleid.md): Fetches a specific automation workflow rule.
  - [Updates an existing automation workflow rule.](https://api.bynder.com/reference/putrulesruleid.md): Updates an existing automation workflow rule.
  - [Deletes an automation workflow rule.](https://api.bynder.com/reference/deleterulesruleid.md): Deletes an automation workflow rule by its ID.
  - [Updates the status of an existing automation workflow rule.](https://api.bynder.com/reference/patchrulesruleidstatus.md): Updates the status of an existing automation workflow rule. The status must be one of the following: `PUBLISHED` or `PAUSED`.
- [Automation Workflow Triggers](https://api.bynder.com/reference/automation-workflow-triggers.md)
  - [Fetches a list of available automation workflow triggers.](https://api.bynder.com/reference/gettriggers.md): Fetches a list of available automation workflow triggers.  <b>Note:</b> The `RelativeDate` trigger must be used with the `Archived` condition.
- [Automation Workflow Conditions](https://api.bynder.com/reference/automation-workflow-conditions.md)
  - [Fetches a list of available automation workflow conditions.](https://api.bynder.com/reference/getconditions.md): Fetches a list of available automation workflow conditions.  Some conditions accept only specific predefined terms, which are included in the response for reference.  <b>Note:</b> The `Archived`…
- [Automation Workflow Actions](https://api.bynder.com/reference/automation-workflow-actions.md)
  - [Fetches a list of available automation workflow actions.](https://api.bynder.com/reference/getactions.md): Fetches a list of available automation workflow actions.  <b>Note:</b> Only actions that the authenticated user has permission to use are included in the response. For example, actions requiring…

## API Reference: Workflow Users and Groups API
- [Users](https://api.bynder.com/reference/users-1.md)
  - [Retrieve users](https://api.bynder.com/reference/get_api-workflow-users.md)
  - [Retrieve specific user](https://api.bynder.com/reference/get_api-workflow-users-id.md)
- [Groups](https://api.bynder.com/reference/groups-1.md)
  - [Retrieve groups](https://api.bynder.com/reference/get_api-workflow-groups.md)
  - [Create group](https://api.bynder.com/reference/post_api-workflow-groups.md)
  - [Retrieve specific group](https://api.bynder.com/reference/get_api-workflow-groups-id.md)
  - [Modify group](https://api.bynder.com/reference/put_api-workflow-groups-id.md)
  - [Delete group](https://api.bynder.com/reference/delete_api-workflow-groups-id.md)

## API Reference: Workflow Metaproperties API
- [Metaproperties](https://api.bynder.com/reference/metaproperties.md)
  - [Retrieve metaproperties](https://api.bynder.com/reference/get_api-workflow-metaproperties.md)
  - [Retrieve specific metaproperty](https://api.bynder.com/reference/get_api-workflow-metaproperties-id.md)

## API Reference: Workflow Campaigns API
- [Campaigns](https://api.bynder.com/reference/campaigns.md)
  - [Retrieve campaigns](https://api.bynder.com/reference/get_api-workflow-campaigns.md): Requires the CAMPAIGNOVERVIEW security role.
  - [Create campaign](https://api.bynder.com/reference/post_api-workflow-campaigns.md): Requires the CAMPAIGNADD security role.
  - [Retrieve specific campaign](https://api.bynder.com/reference/get_api-workflow-campaigns-id.md): Requires the CAMPAIGNOVERVIEW security role.
  - [Modify campaign](https://api.bynder.com/reference/put_api-workflow-campaigns-id.md): Requires the CAMPAIGNEDIT security role.
  - [Delete campaign](https://api.bynder.com/reference/delete_api-workflow-campaigns-id.md): Requires the CAMPAIGNREMOVE security role.
  - [Close campaign](https://api.bynder.com/reference/closecampaign.md): Requires the CAMPAIGNWRITE security role.

## API Reference: Product Layer Metaproperties API
- [Metaproperties](https://api.bynder.com/reference/metaproperties-1.md)
  - [Retrieve metaproperties](https://api.bynder.com/reference/get_api-pim-metaproperties.md): Retrieve a list of metaproperties.
  - [Retrieve specific metaproperty](https://api.bynder.com/reference/get_api-pim-metaproperties-id.md): Retrieve the details of a specific metaproperty.
- [Options](https://api.bynder.com/reference/options.md)
  - [Retrieve metaproperty options](https://api.bynder.com/reference/get_api-pim-metaproperties-id-options.md): Retrieve a paginated list of options for the given metaproperty id.
  - [Modify metaproperty option](https://api.bynder.com/reference/put_api-pim-metapropertyoptions-id.md): Edit the children of a metaproperty option.

## API Reference: Adaptive Video Streaming API
- [Public links](https://api.bynder.com/reference/public-links.md)
  - [Get public links for an asset](https://api.bynder.com/reference/getassetpubliclinks.md): This API returns public links to both HLS and DASH manifests for video assets, as well as the Video player HTML embed code to integrate Adaptive Video Streaming links with a supported video player.…

## API Reference: Brandstore API
- [Orders](https://api.bynder.com/reference/orders.md)
  - [Retrieve orders](https://api.bynder.com/reference/get_api-store-order.md)
  - [Retrieve specific order info](https://api.bynder.com/reference/get_api-store-order-id.md)
  - [Retrieve specific order by id](https://api.bynder.com/reference/get_api-store-order-id-products.md)
  - [Modify order](https://api.bynder.com/reference/post_api-store-order-id-products.md)
  - [Retrieve specific orderline](https://api.bynder.com/reference/get_api-store-orderproducts-id.md)
  - [Modify orderline](https://api.bynder.com/reference/patch_api-store-orderproducts-id.md)

## API Reference: Antivirus API
- [Quarantine](https://api.bynder.com/reference/quarantine.md)
  - [Retrieve a list of quarantined assets](https://api.bynder.com/reference/get_v7-quarantine-v1-assets.md)
  - [Retrieve a quarantined asset by id](https://api.bynder.com/reference/get_v7-quarantine-v1-assets-asset-id.md)
  - [Update review status by id](https://api.bynder.com/reference/put_v7-quarantine-v1-assets-asset-id.md)
  - [Update review status by list of asset Ids](https://api.bynder.com/reference/post_v7-quarantine-v1-antivirus-audit.md)

## API Reference: Webhooks API
- [Configurations](https://api.bynder.com/reference/configurations.md)
  - [Retrieve Webhooks configurations](https://api.bynder.com/reference/getwebhookconfigurations.md): Please be aware that using this endpoint requires either the `View Webhooks configurations` or `Manage Webhooks configurations` security role.
  - [Create a Webhook configuration](https://api.bynder.com/reference/createwebhookconfiguration.md): Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.
  - [Update a Webhook Configuration](https://api.bynder.com/reference/updateawebhookconfiguration.md): Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.
  - [Patch a Webhook Configuration](https://api.bynder.com/reference/patchawebhookconfiguration.md): Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.
  - [Delete a Webhook Configuration](https://api.bynder.com/reference/deleteawebhookconfiguration.md): Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.
- [Ranges](https://api.bynder.com/reference/ranges.md)
  - [Retrieve Webhook IP Ranges](https://api.bynder.com/reference/retrievewebhookipranges.md): Please be aware that using this endpoint requires either the `View Webhooks configurations` or `Manage Webhooks configurations` security role.

## API Reference: Text Authoring API
- [Document](https://api.bynder.com/reference/document.md)
  - [Get document](https://api.bynder.com/reference/getdocument.md): Use this endpoint to retrieve your text content in CXUC. The `$ACCOUNT` is your assigned subdomain, or just replace the URL if you have a custom domain.

## API Reference: Analytics API
- [Asset Usage V2](https://api.bynder.com/reference/asset-usage-v2.md): These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting…
  - [Retrieve asset views](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-views.md)
  - [Retrieve asset downloads](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-downloads.md)
  - [Retrieve asset creations](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-creations.md)
  - [Retrieve asset removes](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-removes.md)
  - [Retrieve asset archives](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-archives.md)
  - [Retrieve asset deletions](https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-deletions.md)
- [Asset Usage V1](https://api.bynder.com/reference/asset-usage-v1.md): These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting…
  - [Retrieve asset view events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-view.md): This endpoint will be deprecated on July, 15th. Use the Asset Views V2 endpoint instead.
  - [Retrieve asset download events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-download.md)
  - [Retrieve asset download events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-v2-download.md): This endpoint only offers data from 2023-11-01. Use the Asset Download endpoint for previous data.
  - [Retrieve asset creation events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-create.md): Retrieve asset creation events within a specified date range.
  - [Retrieve asset archive events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-archive.md): Retrieve archive events for assets within a specified date range.
  - [Retrieve removed asset events](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-remove.md): Retrieve analytics events for removed assets.
  - [Retrieve all events performed in a given asset](https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-assetid.md): This endpoint will allow you to retrieve all the events performed in a given asset.
- [Search Usage](https://api.bynder.com/reference/search-usage.md): These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API…
  - [Retrieve search execution events](https://api.bynder.com/reference/get_v7-analytics-api-v1-search-executions.md)
  - [Retrieve search keyword events](https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword.md): Deprecated. Use the Search Executions endpoint instead.
  - [Retrieve search keyword events in CSV format](https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword-csv.md): Deprecated. Use the Search Executions endpoint instead.
- [User Usage](https://api.bynder.com/reference/user-usage.md): These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API…
  - [User Login](https://api.bynder.com/reference/get_v7-analytics-api-v1-user-login.md): Retrieve login events.
  - [User Activity](https://api.bynder.com/reference/get_v7-analytics-api-v1-user-userid.md): Retrieve all the events triggered by a given user.
  - [Retrieve user logins](https://api.bynder.com/reference/get_v7-analytics-api-v2-user-logins.md)
  - [Retrieve user creations](https://api.bynder.com/reference/get_v7-analytics-api-v2-user-creations.md)
- [Collection Usage](https://api.bynder.com/reference/collection-usage.md): These endpoints return information related to the specific event. You can enrich these events with specific data about the collection or the user by making use of the [Collections API…
  - [Retrieve collection view events](https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views.md)
  - [Retrieve collection view events in CSV format](https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views-csv.md)
  - [Retrieve collection views](https://api.bynder.com/reference/get_v7-analytics-api-v2-collection-views.md)
- [Reporting](https://api.bynder.com/reference/reporting.md): These endpoints provide reporting capabilities for assets of the DAM, making it easier to build your own customised reports.
  - [Retrieve asset reports](https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset.md): This endpoint allows you to retrieve a human readable report of any of the assets in the DAM. The report will include all the metadata of the asset.
  - [Retrieve specific asset report](https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset-assetid.md): This endpoint allows you to retrieve a human readable report for a specific asset in the DAM. The report will include all the metadata of the asset.
- [Historical Data](https://api.bynder.com/reference/historical-data.md): This endpoint provides historical Analytics data beyond the 12 month retention period that applies to the Analytics API endpoints. **Note:** This data isn't available by default. Please, contact your…
  - [Retrieve historical data in CSV format](https://api.bynder.com/reference/get_v7-analytics-api-v1-historical-year-csv.md): This endpoint provides historical Analytics data beyond the 12 month retention period that applies to the Analytics API endpoints.

## API Reference: Brands
- [/api/v4/brands/](https://api.bynder.com/reference/apiv4brands.md)
  - [Retrieve brands](https://api.bynder.com/reference/get_api-v4-brands.md)

## API Reference: Derivative Presets API
- /api/1/derivative-presets/
  - [Retrieve all configured derivative presets.](https://api.bynder.com/reference/retrieveallderivativepresets.md): Retrieve all configured derivative presets.
- /api/1/derivative-presets/{preset_id}
  - [Retrieve a specific configured derivative preset.](https://api.bynder.com/reference/retrievespecificderivativepreset.md): Retrieve a specific configured derivative preset.

## API Reference: CXUC
- [Guides](https://api.bynder.com/reference/guides.md): Guide endpoints
  - [Get all guides](https://api.bynder.com/reference/getguidesapi.md)
  - [Get guide by ID](https://api.bynder.com/reference/getguidebyidapi.md)
  - [Get page of a guide by ID](https://api.bynder.com/reference/getguidepagebyidapi.md)
- [Groups](https://api.bynder.com/reference/groups.md): Group endpoints
  - [Get all groups](https://api.bynder.com/reference/getgroupsapi.md)
  - [Get group by ID](https://api.bynder.com/reference/getgroupbyidapi.md)

## Changelog
- [2026](https://api.bynder.com/changelog/2026.md)
- [2025](https://api.bynder.com/changelog/2025.md)
- [2024](https://api.bynder.com/changelog/2024.md)
- [2023](https://api.bynder.com/changelog/2023.md)
- [2022](https://api.bynder.com/changelog/2022.md)
- [2021](https://api.bynder.com/changelog/2021.md)
- [2020](https://api.bynder.com/changelog/2020.md)
- [2019](https://api.bynder.com/changelog/2019.md)