Skip to main content
GET
/
api
/
activities
List Activities
curl --request GET \
  --url https://platform.kodexa.ai/api/activities \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "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
    }
  ],
  "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 Activity

Paginated response containing Activity items.

​
content
object[]

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