Skip to main content
GET
/
api
/
data-forms
/
{id}
Get DataForms by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/data-forms/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "actions": [
      {
        "name": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "bridge": {
      "apiBaseUrl": "<string>",
      "maxExecutionMs": 123,
      "permissions": [
        "<string>"
      ]
    },
    "cards": [
      {
        "children": "<array>",
        "id": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "editable": true,
    "entrypoints": [
      "<string>"
    ],
    "eventTriggers": [
      {
        "debounce": 123,
        "filter": {
          "dataObjectUUID": "<string>",
          "path": "<string>"
        },
        "on": "<string>",
        "script": "<string>"
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "nodes": [
      {
        "bindings": {},
        "children": "<array>",
        "class": "<unknown>",
        "component": "<string>",
        "computed": {},
        "events": {},
        "for": {
          "indexAs": "<string>",
          "itemAs": "<string>",
          "key": "<string>",
          "source": "<string>"
        },
        "if": "<string>",
        "key": "<string>",
        "meta": {
          "category": "<string>",
          "description": "<string>",
          "designOnly": true,
          "label": "<string>"
        },
        "props": {},
        "ref": "<string>",
        "show": "<string>",
        "slots": {},
        "style": "<unknown>"
      }
    ],
    "options": [
      {
        "default": "<unknown>",
        "description": "<string>",
        "displayProperties": {},
        "label": "<string>",
        "name": "<string>",
        "possibleValues": [
          "<unknown>"
        ],
        "required": true,
        "type": "<string>"
      }
    ],
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "scriptModules": {},
    "scriptTriggers": [
      {
        "debounce": 123,
        "script": "<string>",
        "triggerOn": [
          "<string>"
        ]
      }
    ],
    "scripts": {},
    "version": "<string>",
    "views": [
      {
        "name": "<string>",
        "properties": {}
      }
    ]
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The DataForms

Data form metadata defines a structured data capture form for documents.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the data form was created.

​
deprecated
boolean

Whether this data form is deprecated.

​
extensionPackRef
string
​
id
string

Unique identifier (UUID) for the data form.

​
metadata
object
​
name
string

Display name of the data form.

​
organizationId
string
​
publicAccess
boolean

Whether the data form is publicly accessible.

​
slug
string

URL-friendly identifier for the data form.

​
template
boolean

Whether this data form is a template.

​
type
string
​
updatedOn
string<date-time>

Timestamp when the data form was last updated.

​
uuid
string

Secondary UUID identifier.

​
yamlSource
string | null