Skip to main content
GET
/
api
/
tasks
List Tasks
curl --request GET \
  --url https://platform.kodexa.ai/api/tasks \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "assignee": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "image": "<string>",
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "security": {
          "roles": [
            "<string>"
          ]
        },
        "showDeveloperTools": true,
        "title": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "<string>"
      },
      "assigneeId": "<string>",
      "changeSequence": 123,
      "completedDate": "2023-11-07T05:31:56Z",
      "createdByActivityId": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "deleteUserEmail": "<string>",
      "deleteUserId": "<string>",
      "deleted": true,
      "deletedDate": "2023-11-07T05:31:56Z",
      "description": "Review and validate all Q4 2025 invoices.",
      "dueDate": "2023-11-07T05:31:56Z",
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "locked": true,
      "metadata": {
        "actions": [
          {
            "label": "<string>",
            "properties": {},
            "type": "<string>",
            "uuid": "<string>"
          }
        ],
        "dataProperties": {}
      },
      "parentTask": "<unknown>",
      "parentTaskId": "<string>",
      "plan": {
        "activityPlanId": "<string>",
        "badges": {},
        "changeSequence": 123,
        "completedOn": "2023-11-07T05:31:56Z",
        "completedWorkUnits": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "currentSequence": 123,
        "deleteUserEmail": "<string>",
        "deleteUserId": "<string>",
        "deleted": true,
        "deletedDate": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "errorDetails": "<string>",
        "failedWorkUnits": 123,
        "id": "<string>",
        "inputs": {},
        "lifecycleState": "<string>",
        "metadata": {},
        "organization": {
          "archived": true,
          "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"
        },
        "organizationId": "<string>",
        "parentActivityId": "<string>",
        "priority": 123,
        "projectId": "<string>",
        "replacedByActivityId": "<string>",
        "runningWorkUnits": 123,
        "startedByIntakeId": "<string>",
        "startedByTriggerId": "<string>",
        "startedOn": "2023-11-07T05:31:56Z",
        "steps": [
          {
            "activityId": "<string>",
            "agentId": "<string>",
            "agentRuntimeId": "<string>",
            "agentSessionId": "<string>",
            "approvalCriteria": {},
            "approvalOutcome": "<string>",
            "approverRole": "<string>",
            "bridgeActions": {},
            "bridgeResult": {},
            "bypass": true,
            "changeSequence": 123,
            "childTaskId": "<string>",
            "completedActionUuid": "<string>",
            "completedDocFamilyIds": {},
            "completedOn": "2023-11-07T05:31:56Z",
            "conditionExpression": {},
            "createdOn": "2023-11-07T05:31:56Z",
            "currentDocFamilyId": "<string>",
            "disableCache": true,
            "endpointName": "<string>",
            "enrichment": {},
            "errorDetails": {},
            "executionId": "<string>",
            "id": "<string>",
            "includeDocument": {},
            "insertedAt": "2023-11-07T05:31:56Z",
            "insertedById": "<string>",
            "joinPolicy": "<string>",
            "llmModelName": "<string>",
            "logGroup": "<string>",
            "logStream": "<string>",
            "mappedOutput": {},
            "maxParallel": 123,
            "maxStepsToInsert": 123,
            "moduleRef": "<string>",
            "moduleRefs": {},
            "name": "<string>",
            "options": {},
            "organization": {
              "archived": true,
              "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"
            },
            "organizationId": "<string>",
            "outputMapping": {},
            "perDocument": true,
            "plannerContext": {},
            "prompt": "<string>",
            "promptActions": {},
            "promptBody": "<string>",
            "promptRendered": "<string>",
            "promptResult": {},
            "promptTemplateRef": "<string>",
            "promptVariables": {},
            "requestBody": {},
            "requestHeaders": {},
            "requestPath": {},
            "requestQuery": {},
            "requestScript": "<string>",
            "result": {},
            "scriptActions": {},
            "scriptBody": "<string>",
            "scriptResult": {},
            "scriptSidecars": {},
            "sequence": 123,
            "serviceBridgeRef": "<string>",
            "skipReason": "<string>",
            "slug": "<string>",
            "startedOn": "2023-11-07T05:31:56Z",
            "status": "<string>",
            "taskData": {},
            "taskStatusSlug": "<string>",
            "taskTemplateRef": "<string>",
            "timeoutSeconds": 123,
            "treatAsError": "<string>",
            "type": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>",
            "waitForCompletion": true
          }
        ],
        "title": "<string>",
        "totalWorkUnits": 123,
        "triggerKind": "<string>",
        "triggerMetadata": {},
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "version": 123
      },
      "priority": 1,
      "project": {
        "changeSequence": 123,
        "color": "#4A90D9",
        "createdOn": "2023-11-07T05:31:56Z",
        "dataFlow": {
          "edges": [
            {
              "id": "<string>",
              "properties": {},
              "source": "<string>",
              "target": "<string>"
            }
          ],
          "nodes": [
            {
              "dimensions": {
                "height": 123,
                "width": 123
              },
              "id": "<string>",
              "parentId": "<string>",
              "position": {
                "x": 123,
                "y": 123
              },
              "properties": {},
              "type": "<string>"
            }
          ],
          "viewPort": {
            "x": 123,
            "y": 123,
            "zoom": 123
          }
        },
        "description": "Automated invoice processing pipeline.",
        "documentStatuses": [
          {
            "changeSequence": 123,
            "color": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "icon": "<string>",
            "id": "<string>",
            "project": "<unknown>",
            "projectId": "<string>",
            "slug": "<string>",
            "status": "<string>",
            "statusType": "UNRESOLVED",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          }
        ],
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "memory": {
          "changeSequence": 123,
          "orderedDashboards": [
            "<string>"
          ],
          "recentFilters": {},
          "recentQueries": {}
        },
        "name": "Invoice Processing",
        "notes": "<string>",
        "options": {
          "companion": {
            "agentRuntimeRef": "<string>",
            "moduleRefs": [
              "<string>"
            ],
            "prompt": "<string>"
          },
          "dataOptions": [
            {
              "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>"
            }
          ],
          "dataProperties": {},
          "executionPolicy": {
            "backoffBaseSeconds": 123,
            "backoffStrategy": "<string>",
            "maxAttempts": 123,
            "onExhausted": "<string>",
            "timeoutSeconds": 123
          },
          "groupTaxonTypeFeatures": {},
          "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>"
            }
          ],
          "properties": {},
          "taskOptions": {
            "showNewTask": true,
            "showTakeNext": true
          },
          "taxonTypeFeatures": {}
        },
        "organization": {
          "archived": true,
          "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"
        },
        "organizationId": "<string>",
        "owner": {
          "active": true,
          "bio": "<string>",
          "businessGroup": "<string>",
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "firstName": "<string>",
          "groupsJson": "<string>",
          "id": "<string>",
          "image": "<string>",
          "isExternallyManaged": true,
          "lastName": "<string>",
          "preferences": {
            "showOnboarding": true,
            "showScrollbars": true,
            "showWelcomeMessage": true
          },
          "rolesJson": "<string>",
          "searchText": "<string>",
          "security": {
            "roles": [
              "<string>"
            ]
          },
          "showDeveloperTools": true,
          "title": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "userStorage": {
            "favoriteLinks": [
              {
                "link": "<string>"
              }
            ]
          },
          "userType": "<string>",
          "uuid": "<string>"
        },
        "ownerId": "<string>",
        "projectTemplateRef": "<string>",
        "searchText": "<string>",
        "slug": "invoice-processing",
        "status": {
          "changeSequence": 123,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "icon": "<string>",
          "id": "<string>",
          "organization": {
            "archived": true,
            "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"
          },
          "organizationId": "<string>",
          "production": true,
          "status": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "statusId": "<string>",
        "statusType": "ACTIVE",
        "templateArticleId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "7c9e667974254de944be07fc1f90ae7"
      },
      "projectId": "<string>",
      "properties": {},
      "searchText": "<string>",
      "signal": {
        "metadata": {},
        "notes": "<string>",
        "outcome": "APPROVED",
        "requestedItems": [
          {}
        ]
      },
      "statusSlug": "<string>",
      "taskActivities": [
        {
          "changeSequence": 123,
          "content": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "detail": {
            "interpolatedValues": {},
            "type": "TASK_CREATED"
          },
          "id": "<string>",
          "searchText": "<string>",
          "task": "<unknown>",
          "taskId": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "user": {},
          "userId": "<string>",
          "uuid": "<string>"
        }
      ],
      "taskGroupId": "<string>",
      "team": {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "<string>",
        "name": "<string>",
        "organization": {
          "archived": true,
          "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"
        },
        "organizationId": "<string>",
        "searchText": "<string>",
        "slug": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "teamId": "<string>",
      "template": {
        "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>"
      },
      "templateId": "<string>",
      "title": "Review Q4 invoices",
      "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 Task

Paginated response containing Task items.

​
content
object[]

Array of Task 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.