Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB
Digital Asset Management (DAM)
Custom metadata fields

List all fields

This API returns the array of created custom metadata field objects. By default the API returns only non deleted field objects, but you can include deleted fields in the API response.

You can also filter results by a specific folder path to retrieve custom metadata fields applicable at that location. This path-specific filtering is useful when using the Path policy feature to determine which custom metadata fields are selected for a given path.

get/v1/customMetadataFields

Query parameters

includeDeletedboolean

Set it to true to include deleted field objects in the API response.

folderPathstring

The folder path (e.g., /path/to/folder) for which to retrieve applicable custom metadata fields. Useful for determining path-specific field selections when the Path policy feature is in use.

Response

Array of custom metadata field objects.

idstring required

Unique identifier for the custom metadata field. Use this to update the field.

namestring required

API name of the custom metadata field. This becomes the key while setting customMetadata (key-value object) for an asset using upload or update API.

labelstring required

Human readable name of the custom metadata field. This name is displayed as form field label to the users while setting field value on the asset in the media library UI.

Example response

[
  {
    "schema": {
      "selectOptions": [
        "small",
        "medium",
        "large",
        30,
        40,
        true
      ],
      "defaultValue": [
        true,
        10,
        "Hello"
      ]
    }
  }
]