Skip to main content
GET
/
api
/
task-templates
List TaskTemplates
curl --request GET \
  --url https://platform.kodexa.ai/api/task-templates \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deprecated": true,
      "description": "<string>",
      "id": "<string>",
      "initialStatusSlug": "<string>",
      "metadata": {
        "actions": [
          {
            "label": "<string>",
            "properties": {},
            "type": "<string>",
            "uuid": "<string>"
          }
        ],
        "aiNaming": {
          "enabled": true,
          "prompt": "<string>"
        },
        "chatPrompt": {
          "enabled": true,
          "prompt": "<string>"
        },
        "companion": {
          "agentRuntimeRef": "<string>",
          "moduleRefs": [
            "<string>"
          ],
          "prompt": "<string>"
        },
        "documentFamilyGroups": [
          {
            "automaticallyAdd": true,
            "documentFamilyFilter": "<string>",
            "editable": true,
            "hardMaxPages": 123,
            "knowledgeFeatures": [
              {
                "featureTypeRef": "<string>",
                "required": true
              }
            ],
            "maxHits": 123,
            "maxPages": 123,
            "maxSize": 123,
            "name": "<string>",
            "notes": "<string>",
            "sort": "<string>",
            "titlePrompt": "<string>",
            "uniqueFilenames": true,
            "uploadOnly": true
          }
        ],
        "executionPolicy": {
          "backoffBaseSeconds": 123,
          "backoffStrategy": "<string>",
          "maxAttempts": 123,
          "onExhausted": "<string>",
          "timeoutSeconds": 123
        },
        "forms": [
          {
            "actions": [
              {
                "label": "<string>",
                "properties": {},
                "type": "<string>",
                "uuid": "<string>"
              }
            ],
            "availablePanels": {},
            "dataFormRef": "<string>",
            "properties": {}
          }
        ],
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "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": "<unknown>"
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "priority": 123,
        "properties": {},
        "teamSlug": "<string>",
        "workspaceId": "<string>"
      },
      "name": "<string>",
      "organizationId": "<string>",
      "slug": "<string>",
      "template": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of TaskTemplate

Paginated response containing TaskTemplate items.

​
content
object[]

Array of TaskTemplate items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.