Skip to main content
GET
/
api
/
data-forms
/
{id}
Get DataFormMetadata 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>"
      }
    ],
    "cards": [
      {
        "children": "<array>",
        "id": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "views": [
      {
        "name": "<string>",
        "properties": {}
      }
    ]
  },
  "name": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": "<string>"
}

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 DataFormMetadata

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

Reference to the extension pack.

id
string

Unique identifier (UUID) for the data form.

metadata
object
name
string

Display name of the data form.

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.

updatedOn
string<date-time>

Timestamp when the data form was last updated.

uuid
string

Secondary UUID identifier.

version
string

Semantic version string.