BrainerceGet contact form schema
Returns the full field schema for one contact form: every field's key, type, label, placeholder, whether it is required, and its validation bounds. Render one control per field in the order given, then submit the collected values as the fields object of POST /inquiries — the server re-validates against this same schema and strips unknown keys, so a form built from a stale copy of the schema will have values silently dropped. Labels and placeholders come back translated for locale, falling back to the store language. Rate limited to 60 requests per minute.
For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.
In: header
Path Parameters
Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.
Form key, from contact-forms.
Query Parameters
Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.
Header Parameters
Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.
Preferred language, for example he. Its first tag is used when it is one of the store's supported languages other than the default; translated fields are then returned in that language. Falls back to the locale query parameter.
Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.
curl -X GET "https://api.brainerce.com/api/vc/string/contact-forms/string?locale=string" \ -H "origin: string" \ -H "accept-language: string" \ -H "X-SDK-Version: string"{
"id": "clcf_abc123",
"key": "main",
"name": "string",
"description": "string",
"submitButton": "Send",
"successMessage": "Thanks, we will be in touch.",
"fields": [
{
"key": "message",
"type": "TEXTAREA",
"label": "Your message",
"placeholder": "string",
"helpText": "string",
"isRequired": true,
"enumValues": [
{
"value": "red",
"label": "Red"
}
],
"validation": {
"minLength": 2,
"maxLength": 500,
"min": 1,
"max": 99,
"pattern": "string",
"patternMessage": "string"
},
"defaultValue": "string",
"width": "FULL"
}
]
}{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/contact-forms/{formKey}"
}{
"statusCode": 404,
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/contact-forms/{formKey}"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/contact-forms/{formKey}"
}