Get ActivityPlan by ID

Retrieves a single ActivityPlan by its unique identifier. ActivityPlans are reusable graph-of-steps blueprints that runtime Activities are instantiated from.

GET /api/activity-plans/{id}

Get ActivityPlan by ID

cURL

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

200

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "defaultDescriptionTemplate": "<string>",
  "defaultTitleTemplate": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "documentFamilyGroups": {},
  "extensionPackRef": "<string>",
  "id": "<string>",
  "inputOptions": {},
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "steps": {},
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

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 ActivityPlan

changeSequence · integer<int32>

createdOn · string<date-time>

defaultDescriptionTemplate · string

defaultTitleTemplate · string

deleteUserEmail · string | null

deleteUserId · string | null

deleted · boolean

deletedDate · string<date-time> | null

deprecated · boolean

description · string

documentFamilyGroups · object

extensionPackRef · string

id · string

inputOptions · object

metadata · object

name · string

organizationId · string

publicAccess · boolean

slug · string

steps · object

template · boolean

type · string

updatedOn · string<date-time>

uuid · string

yamlSource · string | null