Skip to main content
GET
/
api
/
messages
List Messages
curl --request GET \
  --url https://platform.kodexa.ai/api/messages \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "assistant": {
        "active": true,
        "assistantRole": "<string>",
        "changeSequence": 123,
        "chatEnabled": true,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "deleted": true,
        "description": "<string>",
        "id": "e4567890-12ab-cdef-3456-789012abcdef",
        "name": "Invoice Extractor",
        "options": {
          "agentRuntimeId": "<string>",
          "complete_label": "<string>",
          "moduleRefs": [
            "<string>"
          ],
          "pipeline": {
            "steps": [
              {
                "conditional": "<string>",
                "executionPolicy": {
                  "backoffBaseSeconds": 123,
                  "backoffStrategy": "<string>",
                  "maxAttempts": 123,
                  "onExhausted": "<string>",
                  "timeoutSeconds": 123
                },
                "name": "<string>",
                "options": {},
                "ref": "<string>",
                "stepType": "<string>"
              }
            ]
          },
          "prompt": "<string>",
          "taxonomies": [
            "<string>"
          ]
        },
        "priorityHint": 123,
        "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": {
            "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": {
              "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>",
        "runOnExistingContent": true,
        "showInTraining": true,
        "slug": "invoice-extractor",
        "subscription": "<string>",
        "testOptions": {},
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "validationErrors": {
          "instances": [
            {
              "description": "<string>",
              "message": "<string>",
              "option": "<string>"
            }
          ]
        }
      },
      "assistantId": "<string>",
      "block": {
        "children": "<array>",
        "id": "<string>",
        "properties": {},
        "type": "<string>"
      },
      "changeSequence": 123,
      "channel": {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "isPrivate": true,
        "kapEnabled": true,
        "name": "<string>",
        "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": {
            "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": {
              "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>",
        "suppressEvents": true,
        "task": {
          "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": {
            "dataProperties": {}
          },
          "parentTask": "<unknown>",
          "parentTaskId": "<string>",
          "plan": {
            "activityPlanId": "<string>",
            "changeSequence": 123,
            "completedOn": "2023-11-07T05:31:56Z",
            "completedWorkUnits": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "currentSequence": 123,
            "description": "<string>",
            "errorDetails": "<string>",
            "failedWorkUnits": 123,
            "id": "<string>",
            "inputs": {},
            "metadata": {},
            "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"
            },
            "organizationId": "<string>",
            "parentActivityId": "<string>",
            "projectId": "<string>",
            "runningWorkUnits": 123,
            "startedByIntakeId": "<string>",
            "startedByTriggerId": "<string>",
            "startedOn": "2023-11-07T05:31:56Z",
            "status": "<string>",
            "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>",
                "kind": "<string>",
                "llmModelName": "<string>",
                "logGroup": "<string>",
                "logStream": "<string>",
                "mappedOutput": {},
                "maxParallel": 123,
                "maxStepsToInsert": 123,
                "moduleRef": "<string>",
                "moduleRefs": {},
                "name": "<string>",
                "options": {},
                "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"
                },
                "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>",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>",
                "waitForCompletion": true
              }
            ],
            "taskId": "<string>",
            "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": {
              "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": {
                "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>"
            }
          ],
          "team": {
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "id": "<string>",
            "name": "<string>",
            "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"
            },
            "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,
                  "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>",
            "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": {
                "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": {
                  "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>",
            "slug": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "templateId": "<string>",
          "title": "Review Q4 invoices",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "taskId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "channelId": "<string>",
      "content": "<string>",
      "context": {
        "activeData": [
          {}
        ],
        "contentObjectId": "<string>",
        "documentFamilyId": "<string>",
        "feedbackOption": {
          "id": "<string>",
          "properties": {}
        },
        "messageTemplate": {
          "id": "<string>",
          "properties": {}
        },
        "page": 123,
        "selectedNodeUuids": [
          "<string>"
        ],
        "storeRef": "<string>",
        "taskId": {
          "id": "<string>",
          "properties": {}
        },
        "taxonomyRefs": [
          "<string>"
        ],
        "workspaceAssistantName": "<string>"
      },
      "createdOn": "2023-11-07T05:31:56Z",
      "eventExpiresAt": "2023-11-07T05:31:56Z",
      "feedback": {
        "options": [
          {
            "color": "<string>",
            "description": "<string>",
            "icon": "<string>",
            "id": "<string>",
            "label": "<string>",
            "options": [
              "<unknown>"
            ],
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "rating": 123
      },
      "id": "<string>",
      "messageSequence": 123,
      "messageType": "TEXT",
      "updatedOn": "2023-11-07T05:31:56Z",
      "user": {
        "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>"
      },
      "userId": "<string>",
      "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 Message

Paginated response containing Message items.

​
content
object[]

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