Get Channel Form Definitions

GET /channels/{myshopifyDomain}/form-definitions

Get Channel Form Definitions

cURL

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

200

{
  "formDefinitions": [
    {
      "_id": "67f8d0eb224ca611de0b5001",
      "type": "custom",
      "title": "Creator Intake Form",
      "description": "Collect creator profile and funnel preferences",
      "isActive": true,
      "fields": [
        {
          "fieldType": "field",
          "name": "headline",
          "label": "Headline",
          "dataType": "string"
        }
      ]
    },
    {
      "_id": "67f8d0eb224ca611de0b5002",
      "type": "custom",
      "title": "Drop Notes Form",
      "isActive": 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

Form definitions retrieved

formDefinitions · object[] · required

Show child attributes