Get DataForms by ID

Retrieves a single DataForms by its unique identifier. Data forms define structured data capture forms for documents.

GET /api/data-forms/{id}

Get DataForms by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/data-forms/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "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": [
      {
        "on": "<string>",
        "script": "<string>",
        "debounce": 123,
        "filter": {
          "dataObjectUUID": "<string>",
          "path": "<string>"
        }
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "nodes": [
      {
        "component": "<string>",
        "bindings": {},
        "children": "<array>",
        "class": "<unknown>",
        "computed": {},
        "events": {},
        "for": {
          "itemAs": "<string>",
          "key": "<string>",
          "source": "<string>",
          "indexAs": "<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": [
      {
        "script": "<string>",
        "triggerOn": [
          "<string>"
        ],
        "debounce": 123
      }
    ],
    "scripts": {},
    "shortcuts": [
      {
        "description": "<string>",
        "key": "<string>",
        "scriptRef": "<string>",
        "altKey": "<unknown>",
        "group": "<string>"
      }
    ],
    "tabOrder": [
      {
        "path": "<string>"
      }
    ],
    "tabOrderGroups": [
      {
        "name": "<string>",
        "paths": [
          "<string>"
        ],
        "forEach": {
          "path": "<string>"
        },
        "nextGroup": "<string>",
        "wrap": "<string>"
      }
    ],
    "tabOrderInitial": "<string>",
    "version": "<string>",
    "views": [
      {
        "name": "<string>",
        "properties": {}
      }
    ]
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "extensionPackRef": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

Authorizations

x-api-keybearerAuth

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

200

application/json

The DataForms

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

changeSequence · integer<int32> · required

Optimistic locking version number.

createdOn · string<date-time> · required

Timestamp when the data form was created.

deleted · boolean · required

deprecated · boolean · required

Whether this data form is deprecated.

id · string · required

Unique identifier (UUID) for the data form.

metadata · object · required

Show child attributes

name · string · required

Display name of the data form.

organizationId · string · required

publicAccess · boolean · required

Whether the data form is publicly accessible.

slug · string · required

URL-friendly identifier for the data form.

template · boolean · required

Whether this data form is a template.

updatedOn · string<date-time> · required

Timestamp when the data form was last updated.

uuid · string · required

Secondary UUID identifier.

deleteUserEmail · string | null

deleteUserId · string | null

deletedDate · string<date-time> | null

extensionPackRef · string

orgSlug · string

organization · object | null

Show child attributes

ref · string

type · string

uri · string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource · string | null