Get Modules by ID

Retrieves a single Modules by its unique identifier. Modules are processing modules that can be executed on documents.

GET /api/modules/{id}

Get Modules by ID

cURL

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

200

{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "additionalTaxonOptions": "<unknown>",
    "allowedHosts": [
      "<string>"
    ],
    "baseDir": "<string>",
    "bridgeType": "<string>",
    "contents": [
      "<string>"
    ],
    "eventAware": true,
    "ignoredContents": [
      "<string>"
    ],
    "inferable": true,
    "inferenceOptions": "<unknown>",
    "messageTemplates": "<unknown>",
    "moduleRuntimeParameters": {},
    "moduleRuntimeRef": "<string>",
    "moduleSidecars": [
      "<string>"
    ],
    "optionTabs": "<unknown>",
    "script": "<string>",
    "scriptLanguage": "<string>",
    "state": "<string>",
    "stateHash": "<string>",
    "supportsScheduling": true,
    "taxonFeatures": "<unknown>",
    "taxonomy": "<unknown>",
    "type": "<string>"
  },
  "moduleStatus": "<string>",
  "moduleType": "<string>",
  "name": "<string>",
  "organization": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "supportsScheduling": true,
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<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 Modules

changeSequence · integer<int32>

createdBy · string | null

createdOn · string<date-time>

deleteUserEmail · string | null

deleteUserId · string | null

deleted · boolean

deletedDate · string<date-time> | null

deprecated · boolean

description · string | null

eventAware · boolean | null

extensionPackRef · string

id · string

metadata · object

Show child attributes

moduleStatus · string

moduleType · string

name · string

organization · object

Show child attributes

organizationId · string

publicAccess · boolean

slug · string

supportsScheduling · boolean | null

template · boolean

type · string

updatedOn · string<date-time>

uuid · string

yamlSource · string | null