API Docs / Operations / Task Workflows / Get Task Workflow Groups

Get Task Workflow Groups

GET /api/tenants/{tenant}/tasks/{taskCode}/workflow/groups

Retrieves comprehensive workflow progress information for a TaskItem.

Returns detailed progress data including:

  • Overall completion statistics (total steps, completed steps, percentage)
  • All workflow steps with current status and assignments
  • Available steps that can be worked on next
  • Steps grouped by workflow groups for organized display

Use this endpoint to:

  • Display workflow progress dashboards
  • Show step-by-step task execution status
  • Identify bottlenecks and available work
  • Track overall workflow completion

Example Response:
{
"totalSteps": 8,
"completedSteps": 3,
"progressPercentage": 37.5,
"allSteps": [...],
"availableSteps": [...],
"groupedSteps": [...]
}

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

taskCode* path string

The task code from the URL

The task code from the URL

Responses

200 OK
401 Unauthorized - Invalid or missing API key

Try it