Skip to main content
GET
Get Activity by ID

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.

Response

The Activity with embedded steps

activityPlanId
string | null
badges
any
changeSequence
integer<int32>
completedOn
string<date-time> | null
completedWorkUnits
integer<int32> | null
createdOn
string<date-time>
currentSequence
integer<int32> | null
deleteUserEmail
string
deleteUserId
string
deleted
boolean
deletedDate
string<date-time> | null
description
string | null
errorDetails
string | null
failedWorkUnits
integer<int32> | null
id
string
inputs
any
lifecycleState
string
metadata
any
organization
object | null

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

organizationId
string | null
parentActivityId
string | null
priority
integer<int32>
projectId
string | null
replacedByActivityId
string | null
runningWorkUnits
integer<int32> | null
startedByIntakeId
string | null
startedByTriggerId
string | null
startedOn
string<date-time> | null
steps
object[]
title
string | null
totalWorkUnits
integer<int32> | null
triggerKind
string
triggerMetadata
any
updatedOn
string<date-time>
uuid
string
version
integer<int32> | null