# Bynder API Documentation > Documentation for Bynder API ## Guides - [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 - [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 back with an authorization code which can then be passed to the Token endpoint. - [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 grant. - [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 grant. - [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 grant. - [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. - [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 API’s responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience. - [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 executing the Specific User or Current User call. - [Retrieve users](https://api.bynder.com/reference/get_api-v4-users.md) - [Create user](https://api.bynder.com/reference/post_api-v4-users.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) - [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 retrieve your current user information. - [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 image derivatives with different dimensions, quality, and format. Bynder can either maintain the original aspect ratio of an image, or crop or pad an image to fit the specified dimensions. We can create smaller versions of your original image asset in both a JPG and PNG file extension. However, the resolution of derivatives can't be larger than the original file. - [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 **GROUPMANAGEMENT** security role. - [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 `user_ids` array is accepted and is a no-op. Requires the **GROUPMANAGEMENT** security role. - [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 `user_ids` array is accepted and is a no-op. Requires the **GROUPMANAGEMENT** security role. - [Retrieve groups](https://api.bynder.com/reference/retrievegroupslegacy.md): Requires the **GROUPMANAGEMENT** security role. - [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. - [Sync asset usage](https://api.bynder.com/reference/post_api-media-usage-sync.md): Sync all usage from a single integration. - [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. - [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 thumbnail image using the [Modern Stack File Upload](https://api.bynder.com/reference/modern-stack-file-upload) flow, then call this endpoint with the returned file id as `customThumbnailFileId`. To remove an existing custom thumbnail and revert to the automatically generated one, call this endpoint with `removeCustomThumbnail=true`. The two fields are mutually exclusive. - [Delete asset](https://api.bynder.com/reference/delete_api-v4-media-id.md): Requires the **MEDIAREMOVE** security role. - [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. - [Delete metaproperty options](https://api.bynder.com/reference/delete_api-media-options.md) - [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 that are in Asset Bank and Waiting room. Creates an empty container, this is the first step to start the file upload and any asset enrichment. - [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 that are in Asset Bank and Waiting room. To start uploading a file as an asset, a signed upload url has to be created, which can be used to start uploading the file. Take the generated assetId from the previous {create Asset} as input in the path. - [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 that are in Asset Bank and Waiting room. This step actually starts uploading the file. Send this request to the signed `uploadUrl` returned by **Create upload url**. This initializes a resumable (tus) upload. Any file namings have to be base64 encoded/decoded. The response headers - in particular the `Location` header - are required for the next call, **Upload file chunks**. > The `{uploadUrl}` path parameter is a placeholder for the signed URL from the previous step. - [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 that are in Asset Bank and Waiting room. The request target is the `Location` response header returned by **Upload file initialization**. Carry the relevant header information across calls as shown below. After the last chunk is uploaded, the file is automatically finalized. > The `Location Header Value` URL is a placeholder for the `Location` header from the previous call. - [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 that are in Asset Bank and Waiting room. Once the file is fully enriched and ready it can be published. Depending on the profile permissions of the user, the asset will go directly to the asset bank (upload assets) or to the waiting room (upload assets with mandatory approval) - [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 that are in Asset Bank and Waiting room. Edit the core properties of an asset. Each property can individually be updated, without needing to send the rest. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Retrieve all metaproperty values set on the active asset version. The responses are taxonomy references, not direct labels. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Update the metaproperty option values of an asset, the given input will overwrite everything metaproperty wise that is on the asset. This does not include tags and autotags. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Update the metaproperty values of a specific metaproperty on an asset. The full list of options or value for the given metaproperty is overwritten. This endpoint can also be used if no values for the given metaproperty are set on the asset yet. > **Note:** doing the update request with an empty list of values will delete the metaproperty and its values from the asset. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Delete a metaproperties options or value from an asset. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Set a given list of tags as the new tag list of an asset. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Create a new current or future embargo on the asset. There are 3 types of embargo available, 'archive', 'watermark', 'limited'. Of which only 1 can be active at the same time. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. For an existing asset embargo, update the date restrictions of that embargo. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Completely delete an existing asset embargo. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Update the value of the asset advanced rights (downloadable, or isPublic). These properties have to be carefully considered when changing, with their potential security implications. Either property can be updated individually. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Adjust the autotag values that are set on an asset. The input list can only set values that are already present on the asset to reduce the list of autotags, not to add additional ones. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Update the set of assets the given asset is related to. The result is a bidirectional relation between the given asset and the asset's given as input Note: the recommended maximum amount of Ids to relate is 100 maximum. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Retrieves all relations defined on an asset, the response will include all relations per relationId. > **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA. - [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 that are in Asset Bank and Waiting room. Retrieves the asset and all its details. This endpoint is currently only available for the creator of the asset to view the asset. During any point of the upload process, the asset can be retrieved to see the active status and the state of the asset. - [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 that are in Asset Bank and Waiting room. Delete an asset that is currently in draft. Due to the draft state, you cannot restore the asset from the trashcan. - [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 that are in Asset Bank and Waiting room. Get all details about a given asset version. This does not have to be the active version of the asset. This endpoint is currently only available for the creator of the asset to view the asset. - [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 that are in Asset Bank and Waiting room. Retrieve the thumbnails of the active version of an asset. The response includes the signed url for directly using the thumbnails. - [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 that are in Asset Bank and Waiting room. Validate if the asset in its current state is good to be published. - [Prepare the upload](https://api.bynder.com/reference/post_v7-file-cmds-upload-prepare.md): Prepare the upload of a file in chunks. - [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. - [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. - [Get closest Amazon S3 upload endpoint](https://api.bynder.com/reference/get-closest-amazon-s3-upload-endpoint.md): Get the closest AmazonS3 upload endpoint. - [Initialise upload](https://api.bynder.com/reference/initialiseupload-1.md): Initialise an upload. - [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 the last part of your multipart upload. For more information about how Amazon handles parts/chunks, visit [Amazon's website](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html). **2. Sending the chunks to Amazon and registering them with Bynder** You can repeat these calls until your file has been uploaded completely. ## Upload a chunk Make a `POST` request to the Amazon upload endpoint you received from calling **Get closest AmazonS3 upload endpoint**. Use `multipart/form-data` to send all of the parameters included in the `multipart_params` of the previous request, plus the additional parameters listed below. - [Register uploaded chunk](https://api.bynder.com/reference/register-uploaded-chunk.md): Register the completion of an uploaded chunk. - [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` endpoint to 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` endpoint to finalize and save an additional uploaded file as a new asset. - [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. - [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 values will be deprecated in the future. Other metaproperties (Date, Text and Longtext), values can be submitted directly. 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 asset` endpoint to update an existing asset with the uploaded file. - [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 asset` endpoint to update an existing asset with the uploaded file. - [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.

This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase. See the example for `assetIds`, and [Note on identifiers](https://api.bynder.com/docs/getting-started#note-on-identifiers) for more information. Additionally, only one of the search parameters (`assetIds`, `imageUrl`, `imageData`, `textQuery`) should be provided per request. Providing multiple parameters will result in a `400` Bad request response. Only OAuth2 authentication is supported for this endpoint, and permanent tokens are not accepted. - [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 item](https://support.bynder.com/hc/en-us/articles/360018559260-Dynamic-Asset-Transformations-DAT-). Image operations can be passed as `io` parameters in the form of `transform:{operation},{param1}:{value1},{param2}:{value2},...`. It's possible to specify several operations: `?io={operation1}&io={operation2}&...`. The operations will be applied in the same order they are passed in the url. These are the possible image operations and their parameters: - [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. - [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/post_api-v4-collections-id-share.md): Share a specific collection by ID. - [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. - [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. __Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked. __Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage. - [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 archived. __Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked. __Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage. - [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 archived. __Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked. __Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage. - [Retrieve metaproperties](https://api.bynder.com/reference/getapi1taxonomymetaproperties.md): Returns a paginated list of metaproperties. - [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 - [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 - [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. - [Retrieve options for a metaproperty](https://api.bynder.com/reference/getapi1taxonomymetapropertiesmetapropertyidoptions.md): Retrieve options for a metaproperty. - [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 - [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. - [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) - [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. - [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. - [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. - [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. - [Retrieve smartfilters](https://api.bynder.com/reference/get_api-v4-smartfilters.md): Retrieve a list of smartfilters. - [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) - [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) - [Retrieve recently removed assets](https://api.bynder.com/reference/get_api-trash-media.md): Retrieve assets removed in the last 30 days. - [Retrieve specific job preset](https://api.bynder.com/reference/get_api-workflow-presets-job-id.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 responsible user or group, use `PUT /api/workflow/stages/{id}`. - [Delete job](https://api.bynder.com/reference/delete_api-workflow-jobs-id.md): Requires the JOBREMOVE security role. - [Retrieve the jobs of a specific campaign](https://api.bynder.com/reference/get_api-workflow-campaigns-id-jobs.md): Requires the CAMPAIGNOVERVIEW security role. - [Retrieve media of specific job](https://api.bynder.com/reference/get_api-workflow-jobs-id-media.md): Requires the JOBOVERVIEW security role. - [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` retrieved from those steps is needed in this request to reference the file to the job. This file will be attached to the job only. **Warning:** Requires the **JOBEDIT** security role. **Warning:** Is only available for Files-Service portals. - [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 job](https://api.bynder.com/reference/patch_api-workflow-jobs-id-finish.md): Requires the JOBAPPROVE security role. - [Retrieve stages of specific job](https://api.bynder.com/reference/get_api-workflow-jobs-id-stages.md): Requires the JOBOVERVIEW security role. - [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 before creating a rule: - `/triggers` – lists available triggers - `/conditions` – lists available conditions - `/actions` – lists available actions - [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`. - [Fetches a list of available automation workflow triggers.](https://api.bynder.com/reference/gettriggers.md): Fetches a list of available automation workflow triggers. Note: The `RelativeDate` trigger must be used with the `Archived` condition. - [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. Note: The `Archived` condition requires the `RelativeDate` trigger. - [Fetches a list of available automation workflow actions.](https://api.bynder.com/reference/getactions.md): Fetches a list of available automation workflow actions. Note: Only actions that the authenticated user has permission to use are included in the response. For example, actions requiring specific features or roles may be omitted if the user lacks access. - [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) - [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) - [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) - [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. - [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. - [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. - [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. This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase. See the example for `asset_id`, and [Note on identifiers](https://api.bynder.com/docs/getting-started#note-on-identifiers) for more information. - [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) - [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) - [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. - [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. - [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. - [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) - [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. - [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 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) - [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) - [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. - [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. - [Retrieve brands](https://api.bynder.com/reference/get_api-v4-brands.md) - [Retrieve all configured derivative presets.](https://api.bynder.com/reference/retrieveallderivativepresets.md): Retrieve all configured derivative presets. - [Retrieve a specific configured derivative preset.](https://api.bynder.com/reference/retrievespecificderivativepreset.md): Retrieve a specific configured derivative preset. - [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) - [Get all groups](https://api.bynder.com/reference/getgroupsapi.md) - [Get group by ID](https://api.bynder.com/reference/getgroupbyidapi.md) ## Changelog - [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)