Get KnowledgeFeatureType by ID

Retrieves a single KnowledgeFeatureType by its unique identifier. Knowledge feature types define the kind of data a knowledge feature can hold.

GET /api/knowledge-feature-types/{id}

Get KnowledgeFeatureType by ID

cURL

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

200

{
  "active": true,
  "changeSequence": 123,
  "color": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "extendedOptions": null,
  "icon": "<string>",
  "id": "<string>",
  "labelJsonPath": "<string>",
  "name": "<string>",
  "options": null,
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "organizationId": "<string>",
  "slug": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "useJSONata": true,
  "uuid": "<string>",
  "orgSlug": "<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 KnowledgeFeatureType

A knowledge feature type defines the kind of data a knowledge feature can hold.

active · boolean · required

changeSequence · integer<int32> · required

color · string · required

createdOn · string<date-time> · required

description · string · required

extendedOptions · unknown · required

icon · string · required

id · string · required

labelJsonPath · string · required

name · string · required

options · unknown · required

organization · object | null · required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

organizationId · string | null · required

slug · string · required

updatedOn · string<date-time> · required

useJSONata · boolean · required

uuid · string · required

orgSlug · string