Get custom metadata field

Get existing custom metadata fields

GET https://api.imagekit.io/v1/customMetadataFields

Get a list of all the custom metadata fields.

Query Parameters

Name	Type	Description
includeDeleted	String	Set it to true if you want to receive deleted fields as well in the API response.

Headers

Name	Type	Description
Authorization*	String	base64 encoding of your_private_api_key: Note the colon in the end.

200 In the response, you will get an array of all the custom metadata fields with each object having field id, name, label and schema.

[
    {
        "id": "598821f949c0a938d57563dd",
        "name": "brand",
        "label": "brand",
        "schema": {
            "type": "Text",
            "defaultValue": "Nike"
        }
    },
    {
        "id": "865421f949c0a835d57563dd"
        "name": "price",
        "label": "price",
        "schema": {
            "type": "Number",
            "minValue": 1000,
            "maxValue": 3000
        }
    }
]

Examples

cURL

curl -X GET "https://api.imagekit.io/v1/customMetadataFields" \
-H 'Content-Type: application/json' \
-u your_private_key:

Node.js

var ImageKit = require("imagekit");

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});

imagekit.getCustomMetadataFields({
    includeDeleted: false
}, function(error, result) {
    if(error) console.log(error);
    else console.log(result);
});

Python

from imagekitio import ImageKit

imagekit = ImageKit(
    public_key='your_public_api_key',
    private_key='your_private_api_key',
    url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)

get_custom_metadata_fields = imagekit.get_custom_metadata_fields()  # by default include_deleted boolean will be considered as False for set it to True, can pass it with imagekit.get_custom_metadata_fields(include_deleted=True)

print("Get custom metadata field-", get_custom_metadata_fields, end="\n\n")

# Raw Response
print(get_custom_metadata_fields.response_metadata.raw)

# print the first customMetadataField's id
print(get_custom_metadata_fields.list[0].id)

# print the first customMetadataField schema's type
print(get_custom_metadata_fields.list[0].schema.type)

PHP

use ImageKit\ImageKit;

$public_key = "your_public_api_key";
$your_private_key = "your_private_api_key";
$url_end_point = "https://ik.imagekit.io/your_imagekit_id";

$imageKit = new ImageKit(
    $public_key,
    $your_private_key,
    $url_end_point
);

$includeDeleted = false;
$getCustomMetadataField = $imageKit->getCustomMetadataFields($includeDeleted);

echo("Get Custom Metadata Field : " . json_encode($getCustomMetadataField));

Java

boolean includeDeleted = false;
ResultCustomMetaDataFieldList resultCustomMetaDataFieldList = ImageKit.getInstance().getCustomMetaDataFields(includeDeleted);

Ruby

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.get_custom_metadata_fields(include_deleted: false)

Go

resp, err := ik.Metadata.CustomFields(ctx, false)

.Net

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
ResultCustomMetaDataFieldList resultCustomMetaDataFieldList = imagekit.GetCustomMetaDataFields(false);