Get Channel Custom Field Definitions

GET /channels/{myshopifyDomain}/custom-field-definitions

Get Channel Custom Field Definitions

cURL

curl --request GET \
  --url https://unified-api.creatorcommerce.shop/channels/{myshopifyDomain}/custom-field-definitions \
  --header 'x-channel-access-token: <api-key>'

200

{
  "customFieldDefinitions": [
    {
      "_id": "67f8c4da35d6e293b9c2a111",
      "ownerType": "collab",
      "name": "Hero Header",
      "description": "Top hero heading for creator storefront",
      "handle": "cc-hero-header",
      "type": "single_line_text_field",
      "isEditable": true,
      "isCreatorEditable": true,
      "isDeleted": false
    },
    {
      "_id": "67f8c4da35d6e293b9c2a112",
      "ownerType": "drop",
      "name": "Drop Subtitle",
      "handle": "cc-drop-subtitle",
      "type": "multi_line_text_field",
      "isEditable": true,
      "isCreatorEditable": true
    }
  ]
}

Authorizations

x-channel-access-token · string · header · required

Channel or partner access token (x-channel-access-token or x-partner-access-token)

Path Parameters

myshopifyDomain · string · required

Response

200

application/json

Custom field definitions retrieved

customFieldDefinitions · object[] · required

Show child attributes