Forms

Dynamic form generation and submission

Get form schema

get

Returns the form schema and configuration for generating a form UI.

Path parameters

form_idintegerRequired

Form identifier

Responses

200

Form schema retrieved

application/json

Dynamic form with JSON schema defining field definitions, validation rules, and actions. Used for generating form UIs and processing form submissions. Supports multi-language translations and pretty URLs. The schema defines input types, labels, and required fields.

pkintegerRequiredExample: 1

namestringOptionalExample: Contact Form

urlstringOptionalExample: /contact/

templatestringOptionalExample: cms/form.html

is_activebooleanRequiredExample: true

created_datestring · date-timeOptional

modified_datestring · date-timeOptional

404

Form not found or not active

get

/forms/{form_id}/generate

HTTPcURLJavaScriptPython

GET /forms/{form_id}/generate HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 1,
  "name": "Contact Form",
  "url": "/contact/",
  "schema": {
    "name": {
      "input_type": "text",
      "label": "Name",
      "required": true
    },
    "email": {
      "input_type": "email",
      "label": "Email",
      "required": true
    }
  },
  "template": "cms/form.html",
  "is_active": true,
  "pretty_url": {
    "url": "text"
  },
  "formprettyurl_set": [
    {
      "pk": 1,
      "url": "text",
      "language": "text"
    }
  ],
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_date": "2026-03-06T21:57:19.899Z",
  "modified_date": "2026-03-06T21:57:19.899Z"
}

Submit form data

post

Submits form data for processing. The request body structure depends on the form schema. Returns validation errors if the data does not match the form schema.

Path parameters

form_idintegerRequired

Form identifier

Body

application/json

Form data structure depends on the form schema

Other propertiesanyOptional

Responses

200

Form submitted successfully

application/json

objectOptional

400

Validation error

application/json

404

Form not found or not active

post

/forms/{form_id}/generate

HTTPcURLJavaScriptPython

POST /forms/{form_id}/generate HTTP/1.1
Host: sandbox.akinon.com
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{}