Skip to main content
GET
/
api
/
activities
/
{id}
/
steps
/
{stepId}
/
document-families
List document family executions for an activity step
curl --request GET \
  --url https://platform.kodexa.ai/api/activities/{id}/steps/{stepId}/document-families \
  --header 'x-api-key: <api-key>'
[
  {
    "completedOn": "2023-11-07T05:31:56Z",
    "documentFamilyId": "<string>",
    "documentFamilyPath": "<string>",
    "errorDetails": {},
    "executionId": "<string>",
    "id": "<string>",
    "inputContentObjectId": "<string>",
    "outputContentObjectId": "<string>",
    "plannedItemId": "<string>",
    "startedOn": "2023-11-07T05:31:56Z",
    "status": "<string>"
  }
]

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.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

​
stepId
string<uuid>
required

Unique identifier (UUID) of the step within the activity.

Response

Document family executions for the step

​
completedOn
string<date-time> | null

When processing completed.

​
documentFamilyId
string

ID of the document family processed.

​
documentFamilyPath
string | null

Path of the document family within its store.

​
errorDetails
object

Error details JSON when processing failed.

​
executionId
string | null

ID of the execution that processed this document, if any.

​
id
string

Unique identifier of the planned-item-document row.

​
inputContentObjectId
string | null

Content object ID of the input KDDB the step consumed.

​
outputContentObjectId
string | null

Content object ID of the output KDDB the step produced (falls back to input CO for non-content-producing steps).

​
plannedItemId
string

Step ID this document was processed by. Field name preserved verbatim from the legacy /api/plans shape for UI parity.

​
startedOn
string<date-time> | null

When processing started.

​
status
string

Processing status (PENDING, RUNNING, COMPLETED, FAILED, etc.).