Skip to main content
GET
/
api
/
data-definitions
/
{id}
Get Taxonomies by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/data-definitions/{id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://platform.kodexa.ai/api/data-definitions/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://platform.kodexa.ai/api/data-definitions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/data-definitions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/data-definitions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://platform.kodexa.ai/api/data-definitions/{id}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/data-definitions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "d3456789-01ab-cdef-2345-678901abcdef",
  "metadata": {
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "enabled": true,
    "externalDataTaxonomyRefs": [
      "<string>"
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "taxonomyType": "<string>",
    "taxons": [
      {
        "additionContexts": [
          "<string>"
        ],
        "children": "<array>",
        "color": "<string>",
        "conditionalFormats": [
          {
            "background": "<string>",
            "color": "<string>",
            "condition": "<string>",
            "formula": "<string>",
            "icon": "<string>",
            "name": "<string>",
            "properties": {},
            "style": "<string>",
            "type": "<string>"
          }
        ],
        "dataPath": "<string>",
        "description": "<string>",
        "enabled": true,
        "eventSubscriptions": [
          {
            "dependsOn": [
              "<string>"
            ],
            "disabled": true,
            "name": "<string>",
            "on": "<string>",
            "script": "<string>"
          }
        ],
        "externalName": "<string>",
        "generateName": true,
        "group": true,
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>",
            "weight": 123
          }
        ],
        "multiValue": true,
        "name": "<string>",
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {
              "columns": 123,
              "rows": 123,
              "width": 123
            },
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "properties": {
              "color": "<string>",
              "icon": "<string>"
            },
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "order": 123,
        "overviewMarkdown": "<string>",
        "path": "<string>",
        "properties": {
          "alignment": "<string>",
          "visible": true,
          "width": 123
        },
        "selectionOptionFormula": "<string>",
        "selectionOptions": [
          {
            "conditionalFormula": "<string>",
            "description": "<string>",
            "disabled": "<string>",
            "hint": "<string>",
            "hintMarkdown": true,
            "id": "<string>",
            "isConditional": true,
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>",
                "weight": 123
              }
            ],
            "value": "<string>"
          }
        ],
        "semanticDefinition": "<string>",
        "synonyms": [
          "<string>"
        ],
        "typeFeatures": {
          "allowTemplating": true,
          "cardinality": "<string>",
          "chunkingStrategy": "<string>",
          "classificationContent": "<string>",
          "classificationStrategy": "<string>",
          "contextHeadLines": 123,
          "contextTailLines": 123,
          "currencyCode": "<string>",
          "dateFormat": "<string>",
          "decimalPlaces": 123,
          "embedded": true,
          "enableAiFallback": true,
          "enableLineFallback": true,
          "enablePlanningThinkingMode": true,
          "enableStructureReview": true,
          "enableStructureReviewThinkingMode": true,
          "enableThinkingMode": true,
          "expected": true,
          "extractionModel": "<string>",
          "formulaExpression": "<string>",
          "hierarchyMaxLinesPerCall": 123,
          "hierarchyWindowOverlap": 123,
          "ignoreNonWords": true,
          "imageWidth": 123,
          "includeDataElementsInClassificationPrompt": true,
          "includeExplanation": true,
          "includeImages": true,
          "instanceBoundaryThreshold": 123,
          "labelDocument": true,
          "markdown": true,
          "maxChildLines": 123,
          "maxPagesFromRerank": 123,
          "merge": true,
          "mergeInstances": true,
          "mergeInstructions": "<string>",
          "mergeWithAI": true,
          "nPages": 123,
          "overrideExtractionModel": true,
          "planningModel": "<string>",
          "promptStrategy": "<string>",
          "raiseExceptionOnAiFallback": true,
          "raiseExceptionOnFallback": true,
          "rerank": true,
          "restrictClassification": true,
          "skipExtraction": true,
          "structureReview": "<string>",
          "summarize": true,
          "tagPage": true
        },
        "useSelectionOptionFormula": true,
        "userEditable": true,
        "validationRules": [
          {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        ]
      }
    ]
  },
  "name": "Invoice Taxonomy",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "invoice-taxonomy",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<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 Taxonomies

Taxonomy metadata defines document structure and extraction rules (data definitions).

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the taxonomy was created.

​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean

Whether this taxonomy is deprecated.

​
extensionPackRef
string
​
id
string

Unique identifier (UUID) for the taxonomy.

Example:

"d3456789-01ab-cdef-2345-678901abcdef"

​
metadata
object
​
name
string

Display name of the taxonomy.

Example:

"Invoice Taxonomy"

​
organizationId
string
​
publicAccess
boolean

Whether the taxonomy is publicly accessible.

​
slug
string

URL-friendly identifier for the taxonomy.

Example:

"invoice-taxonomy"

​
template
boolean

Whether this taxonomy is a template.

​
type
string
​
updatedOn
string<date-time>

Timestamp when the taxonomy was last updated.

​
uuid
string

Secondary UUID identifier.

​
yamlSource
string | null