List Tasks
curl --request GET \
--url https://platform.kodexa.ai/api/tasks \
--header 'x-api-key: <api-key>'import requests
url = "https://platform.kodexa.ai/api/tasks"
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/tasks', 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/tasks",
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/tasks"
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/tasks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/tasks")
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{
"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": "<unknown>",
"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": "<unknown>",
"lifecycleState": "<string>",
"metadata": "<unknown>",
"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": "<unknown>",
"approvalOutcome": "<string>",
"approverRole": "<string>",
"bridgeActions": "<unknown>",
"bridgeResult": "<unknown>",
"bypass": true,
"changeSequence": 123,
"childTaskId": "<string>",
"completedActionUuid": "<string>",
"completedDocFamilyIds": "<unknown>",
"completedOn": "2023-11-07T05:31:56Z",
"conditionExpression": "<unknown>",
"createdOn": "2023-11-07T05:31:56Z",
"currentDocFamilyId": "<string>",
"description": "<string>",
"disableCache": true,
"endpointName": "<string>",
"enrichment": "<unknown>",
"errorDetails": "<unknown>",
"executionId": "<string>",
"id": "<string>",
"includeDocument": "<unknown>",
"insertedAt": "2023-11-07T05:31:56Z",
"insertedById": "<string>",
"joinPolicy": "<string>",
"llmModelName": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"mappedOutput": "<unknown>",
"maxParallel": 123,
"maxStepsToInsert": 123,
"moduleRef": "<string>",
"moduleRefs": "<unknown>",
"name": "<string>",
"options": "<unknown>",
"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": "<unknown>",
"perDocument": true,
"plannerContext": "<unknown>",
"prompt": "<string>",
"promptActions": "<unknown>",
"promptBody": "<string>",
"promptRendered": "<string>",
"promptResult": "<unknown>",
"promptTemplateRef": "<string>",
"promptVariables": "<unknown>",
"requestBody": "<unknown>",
"requestHeaders": "<unknown>",
"requestPath": "<unknown>",
"requestQuery": "<unknown>",
"requestScript": "<string>",
"result": "<unknown>",
"scriptActions": "<unknown>",
"scriptBody": "<string>",
"scriptResult": "<unknown>",
"scriptSidecars": "<unknown>",
"sequence": 123,
"serviceBridgeRef": "<string>",
"skipReason": "<string>",
"slug": "<string>",
"startedOn": "2023-11-07T05:31:56Z",
"status": "<string>",
"taskData": "<unknown>",
"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": "<unknown>",
"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>",
"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
},
"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>",
"requestedItems": [
{}
]
},
"statusSlug": "<string>",
"taskActivities": [
{
"changeSequence": 123,
"content": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"detail": {
"interpolatedValues": {}
},
"id": "<string>",
"searchText": "<string>",
"task": "<unknown>",
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": "<unknown>",
"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>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<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
}Tasks
List Tasks
Returns a paginated list of Tasks. Tasks represent units of work in document review workflows, with assignees, statuses, and due dates.
GET
/
api
/
tasks
List Tasks
curl --request GET \
--url https://platform.kodexa.ai/api/tasks \
--header 'x-api-key: <api-key>'import requests
url = "https://platform.kodexa.ai/api/tasks"
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/tasks', 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/tasks",
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/tasks"
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/tasks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/tasks")
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{
"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": "<unknown>",
"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": "<unknown>",
"lifecycleState": "<string>",
"metadata": "<unknown>",
"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": "<unknown>",
"approvalOutcome": "<string>",
"approverRole": "<string>",
"bridgeActions": "<unknown>",
"bridgeResult": "<unknown>",
"bypass": true,
"changeSequence": 123,
"childTaskId": "<string>",
"completedActionUuid": "<string>",
"completedDocFamilyIds": "<unknown>",
"completedOn": "2023-11-07T05:31:56Z",
"conditionExpression": "<unknown>",
"createdOn": "2023-11-07T05:31:56Z",
"currentDocFamilyId": "<string>",
"description": "<string>",
"disableCache": true,
"endpointName": "<string>",
"enrichment": "<unknown>",
"errorDetails": "<unknown>",
"executionId": "<string>",
"id": "<string>",
"includeDocument": "<unknown>",
"insertedAt": "2023-11-07T05:31:56Z",
"insertedById": "<string>",
"joinPolicy": "<string>",
"llmModelName": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"mappedOutput": "<unknown>",
"maxParallel": 123,
"maxStepsToInsert": 123,
"moduleRef": "<string>",
"moduleRefs": "<unknown>",
"name": "<string>",
"options": "<unknown>",
"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": "<unknown>",
"perDocument": true,
"plannerContext": "<unknown>",
"prompt": "<string>",
"promptActions": "<unknown>",
"promptBody": "<string>",
"promptRendered": "<string>",
"promptResult": "<unknown>",
"promptTemplateRef": "<string>",
"promptVariables": "<unknown>",
"requestBody": "<unknown>",
"requestHeaders": "<unknown>",
"requestPath": "<unknown>",
"requestQuery": "<unknown>",
"requestScript": "<string>",
"result": "<unknown>",
"scriptActions": "<unknown>",
"scriptBody": "<string>",
"scriptResult": "<unknown>",
"scriptSidecars": "<unknown>",
"sequence": 123,
"serviceBridgeRef": "<string>",
"skipReason": "<string>",
"slug": "<string>",
"startedOn": "2023-11-07T05:31:56Z",
"status": "<string>",
"taskData": "<unknown>",
"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": "<unknown>",
"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>",
"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
},
"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>",
"requestedItems": [
{}
]
},
"statusSlug": "<string>",
"taskActivities": [
{
"changeSequence": 123,
"content": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"detail": {
"interpolatedValues": {}
},
"id": "<string>",
"searchText": "<string>",
"task": "<unknown>",
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": "<unknown>",
"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>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<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
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Query Parameters
Page number (1-indexed). Defaults to 1.
Number of items per page (1-1000). Defaults to 20, maximum 1000.
Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.
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
Full-text search query matching against the entity's searchable fields.
Optional response projection. When set to summary, the embedded activity plan is omitted from each Task in the list, returning a lighter payload for high-volume listing (for example a task-group queue). Omit the parameter for the full representation. Does not affect GET /api/tasks/{id}.
Available options:
summary Response
Page of Task
Paginated response containing Task items.
Array of Task items on this page.
Show child attributes
Show child attributes
Whether this is the first page.
Whether this is the last page.
Current page number (0-indexed).
Number of items on the current page.
Pagination metadata.
Show child attributes
Show child attributes
Page size (number of items per page).
Sort metadata.
Show child attributes
Show child attributes
Total number of items across all pages.
Total number of pages.
⌘I