Get a Form's Schema

curl "https://api.raykoi.com/api/v1/forms/p/YOUR_PUBLIC_ID"

{
  "form": {
    "id": "YOUR_PUBLIC_ID",
    "name": "Contact form",
    "accepting_submissions": true,
    "allowed_origins": [],
    "schema": {
      "fields": [
        { "id": "email", "type": "email", "label": "Email", "required": true }
      ]
    }
  },
  "captcha": { "provider": "turnstile", "siteKey": "0x4AAA...", "widgetMode": "invisible" }
}

GET

api

forms

{public_id}

curl "https://api.raykoi.com/api/v1/forms/p/YOUR_PUBLIC_ID"

{
  "form": {
    "id": "YOUR_PUBLIC_ID",
    "name": "Contact form",
    "accepting_submissions": true,
    "allowed_origins": [],
    "schema": {
      "fields": [
        { "id": "email", "type": "email", "label": "Email", "required": true }
      ]
    }
  },
  "captcha": { "provider": "turnstile", "siteKey": "0x4AAA...", "widgetMode": "invisible" }
}

Used internally by the SDK to build local validation and auto-acquire a CAPTCHA token — you generally don’t need to call this directly unless you’re building a fully custom UI driven off the schema.

string

required

The form’s public ID.

Response

object

The form’s public configuration — id (the public ID, never the internal primary key), name, accepting_submissions, schema.fields[], allowed_origins. Internal-only fields (workspace ID, CAPTCHA integration secrets) are never included.

object | null

{ provider, siteKey, widgetMode } if this form has CAPTCHA configured, otherwise null. provider is one of turnstile, hcaptcha, recaptcha.

curl "https://api.raykoi.com/api/v1/forms/p/YOUR_PUBLIC_ID"

{
  "form": {
    "id": "YOUR_PUBLIC_ID",
    "name": "Contact form",
    "accepting_submissions": true,
    "allowed_origins": [],
    "schema": {
      "fields": [
        { "id": "email", "type": "email", "label": "Email", "required": true }
      ]
    }
  },
  "captcha": { "provider": "turnstile", "siteKey": "0x4AAA...", "widgetMode": "invisible" }
}

Field schema shape

Each entry in schema.fields[]:

string

Stable field identifier.

string

Optional override for the submission key — when present, the field’s value is submitted under key instead of id.

string

One of text, textarea, email, phone, number, select, multiselect, radio, checkbox, date, time, datetime, file, signature, rating, scale, and others — see the SDK’s FieldType export for the complete list.

boolean

Whether the field must be present and non-empty.

string[] / number

File-type fields only — see File Uploads.

​Response

​Field schema shape

Response

Field schema shape