Skip to main content
GET
/
api
/
public
/
v1
/
forms
/
{codeOrId}
/
schema
Error
A valid request URL is required to generate request examples
{
  "code": "contact_us",
  "title": "Contact us",
  "submitLabel": "Send",
  "fields": [
    {
      "name": "email",
      "type": "email",
      "label": "Email",
      "required": true,
      "placeholder": null,
      "help": null,
      "options": null,
      "config": null,
      "validation": {
        "format": "email"
      }
    }
  ],
  "publishedAt": "2026-06-10T00:00:00+00:00"
}

Authorizations

publicKey
string
query
required

Public widget/form key (pk_live_…). Exchanged for a session token by POST /api/public/v1/chat/sessions. Public Forms operations accept the same key directly, supplied via this publicKey query param, the X-Comerix-Public-Key header (publicFormKey scheme), or in the JSON body.

Path Parameters

codeOrId
string
required

The form's stable code or its UUID.

Query Parameters

publicKey
string

Public gateway key. Alternatively send X-Comerix-Public-Key.

Response

The form schema document — published (X-Edge-Source: store) or its identical live-computed fallback (X-Edge-Source: live).

The cacheable form schema document served by GET /api/public/v1/forms/{codeOrId}/schema — the same render-safe shape as PublicFormSchema minus locale, plus the edge publication timestamp.

code
string
required
title
string
required
submitLabel
string
required
fields
object[]
required
publishedAt
string<date-time> | null
required

Publication time of the served edge document; null when the response was computed live.