Get TaskStatus by ID

Retrieves a single TaskStatus by its unique identifier. Task statuses define named states for tracking task workflow progress.

GET /api/task-statuses/{id}

Get TaskStatus by ID

cURL

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

200

{
  "changeSequence": 123,
  "color": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "icon": "<string>",
  "id": "<string>",
  "label": "<string>",
  "locked": true,
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "sequence": 123,
  "slug": "<string>",
  "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 TaskStatus

A task status defines a named state for tracking task workflow progress.

changeSequence · integer<int32>

color · string

createdOn · string<date-time>

deleteUserEmail · string | null

deleteUserId · string | null

deleted · boolean

deletedDate · string<date-time> | null

deprecated · boolean

extensionPackRef · string

icon · string

id · string

label · string

locked · boolean | null

metadata · object

name · string

organizationId · string

publicAccess · boolean

sequence · integer<int32>

slug · string

statusType · enum<string>

Available options: OPEN, IN_PROGRESS, DONE, BLOCKED, PENDING

template · boolean

type · string

updatedOn · string<date-time>

uuid · string

yamlSource · string | null