Get a Custom Field by Internal Name

Get a Custom Fields by Internal Name

GET https://{{accountSlug}}.myeshopbox.com/api/platform/v1/property/:internalName

This endpoint allows you to get a custom fields by internal name .

Path Parameters

Name	Type	Description
internalName	string	It is the unique name of the property.

Headers

Name	Type	Description
Authorization	string	The Bearer token to grant access to the API.

200 Custom field by internal name successfully retrieved.

{
    "data": [
        {
            "label": "occassion",
            "internalName": "occassion",
            "description": "occassion dresses",
            "isUnique": "no",
            "fieldType": "multi_select",
            "options": [
                "red,blue,green"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-02-27T18:32:15.528+05:30",
            "updatedAt": "2020-02-27T18:32:15.528+05:30"
        }
    ],
    "page": 1,
    "perPage": 25,
    "total": "1"
}

curl

curl --location --request GET 'http://localhost:8080/_ah/api/esb/v1/property/occassion' \
--header 'Content-Type: application/json' \
--header 'Authorization: '