Get Activity by ID

Retrieves a single Activity by its unique identifier. The response embeds the activity’s steps (ordered by sequence ascending) so a single round-trip suffices — collapses the legacy GET /api/plans/{id} + GET /api/plans/{id}/items pair.

GET /api/activities/{id}

Get Activity by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/activities/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "activityPlanId": "<string>",
  "changeSequence": 123,
  "completedOn": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "currentSequence": 123,
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "lifecycleState": "<string>",
  "metadata": null,
  "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",
    "archived": true
  },
  "organizationId": "<string>",
  "priority": 123,
  "projectId": "<string>",
  "startedOn": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "triggerKind": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": 123,
  "activityPlanSlug": "<string>",
  "badges": null,
  "candidateKnowledgeSets": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "status": "<string>",
      "currentSnapshotId": "<string>",
      "openQuestions": null,
      "projectId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "completedWorkUnits": 123,
  "description": "<string>",
  "documentFamilies": [
    {
      "id": "<string>",
      "path": "<string>"
    }
  ],
  "errorDetails": "<string>",
  "failedWorkUnits": 123,
  "inputs": null,
  "knowledgeAgent": true,
  "knowledgeFeatures": [
    {
      "id": "<string>",
      "slug": "<string>",
      "featureTypeColor": "<string>",
      "featureTypeIcon": "<string>",
      "featureTypeId": "<string>",
      "featureTypeName": "<string>",
      "featureTypeSlug": "<string>"
    }
  ],
  "parentActivityId": "<string>",
  "replacedByActivityId": "<string>",
  "runningWorkUnits": 123,
  "startedByIntakeId": "<string>",
  "startedByTriggerId": "<string>",
  "steps": [
    {
      "activityId": "<string>",
      "changeSequence": 123,
      "completedOn": "2023-11-07T05:31:56Z",
      "conditionExpression": null,
      "createdOn": "2023-11-07T05:31:56Z",
      "errorDetails": null,
      "id": "<string>",
      "insertedAt": "2023-11-07T05:31:56Z",
      "insertedById": "<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",
        "archived": true
      },
      "organizationId": "<string>",
      "sequence": 123,
      "startedOn": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "type": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "agentId": "<string>",
      "agentRuntimeId": "<string>",
      "agentSessionId": "<string>",
      "approvalCriteria": null,
      "approvalOutcome": "<string>",
      "approverRole": "<string>",
      "bridgeActions": null,
      "bridgeResult": null,
      "bypass": true,
      "childTaskId": "<string>",
      "completedActionUuid": "<string>",
      "completedDocFamilyIds": null,
      "currentDocFamilyId": "<string>",
      "dependsOn": [
        {
          "id": "<string>",
          "actionUuid": "<string>",
          "awaitOnly": true
        }
      ],
      "description": "<string>",
      "disableCache": true,
      "endpointName": "<string>",
      "enrichment": null,
      "executionId": "<string>",
      "includeDocument": null,
      "joinPolicy": "<string>",
      "llmModelName": "<string>",
      "logGroup": "<string>",
      "logStream": "<string>",
      "mappedOutput": null,
      "maxParallel": 123,
      "maxStepsToInsert": 123,
      "metadata": null,
      "moduleRef": "<string>",
      "moduleRefs": null,
      "options": null,
      "outputMapping": null,
      "perDocument": true,
      "plannerContext": null,
      "prompt": "<string>",
      "promptActions": null,
      "promptBody": "<string>",
      "promptRendered": "<string>",
      "promptResult": null,
      "promptTemplateRef": "<string>",
      "promptVariables": null,
      "requestBody": null,
      "requestHeaders": null,
      "requestPath": null,
      "requestQuery": null,
      "requestScript": "<string>",
      "result": null,
      "scriptActions": null,
      "scriptBody": "<string>",
      "scriptResult": null,
      "scriptSidecars": null,
      "serviceBridgeRef": "<string>",
      "setDocumentStatus": "<string>",
      "skipReason": "<string>",
      "slug": "<string>",
      "taskData": null,
      "taskStatusSlug": "<string>",
      "taskTemplateRef": "<string>",
      "timeoutSeconds": 123,
      "treatAsError": "<string>",
      "waitForCompletion": true
    }
  ],
  "totalWorkUnits": 123,
  "triggerMetadata": null
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

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

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Response

200

application/json

The Activity with embedded steps

activityPlanId · string | null · required

changeSequence · integer<int32> · required

completedOn · string<date-time> | null · required

createdOn · string<date-time> · required

currentSequence · integer<int32> | null · required

deleteUserEmail · string · required

deleteUserId · string · required

deleted · boolean · required

deletedDate · string<date-time> | null · required

id · string · required

lifecycleState · string · required

metadata · unknown · required

organization · object | null · required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

organizationId · string | null · required

priority · integer<int32> · required

projectId · string | null · required

startedOn · string<date-time> | null · required

title · string | null · required

triggerKind · string · required

updatedOn · string<date-time> · required

uuid · string · required

version · integer<int32> | null · required

activityPlanSlug · string | null

badges · unknown

candidateKnowledgeSets · object[] | null

Show child attributes

completedWorkUnits · integer<int32> | null

description · string | null

documentFamilies · object[] | null

Show child attributes

errorDetails · string | null

failedWorkUnits · integer<int32> | null

inputs · unknown

knowledgeAgent · boolean | null

knowledgeFeatures · object[] | null

Show child attributes

parentActivityId · string | null

replacedByActivityId · string | null

runningWorkUnits · integer<int32> | null

startedByIntakeId · string | null

startedByTriggerId · string | null

steps · object[] | null

Show child attributes

totalWorkUnits · integer<int32> | null

triggerMetadata · unknown