Skip to main content
GET
/
channels
/
{myshopifyDomain}
/
form-definitions
/
{formDefinitionId}
Get Channel Form Definition
curl --request GET \
  --url https://unified-api.creatorcommerce.shop/channels/{myshopifyDomain}/form-definitions/{formDefinitionId} \
  --header 'x-channel-access-token: <api-key>'
{
  "formDefinition": {
    "_id": "67f8d0eb224ca611de0b5001",
    "type": "custom",
    "title": "Creator Intake Form",
    "description": "Collect creator profile and storefront metadata",
    "isActive": true,
    "fields": [
      {
        "fieldType": "field",
        "name": "headline",
        "label": "Headline",
        "dataType": "string"
      }
    ]
  }
}

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
​
formDefinitionId
string
required

Response

Form definition retrieved

​
formDefinition
object
required