Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessments

Get Assessment Workflow Stages

Use this API to retrieve workflow and approval stage details of an assessment. The response will include details such as the workflow ID, workflow name, stage ID, and stage name.

🗒 Things to Know

  • Workflow stage indicates the current stage of the workflow that the assessment is in.
get/api/assessment/v2/assessments/{assessmentId}/workflows

Path parameters

assessmentIdstring uuid required

The unique ID of the assessment to retrieve workflow details for

Response

OK

workflowIdstring uuid

The unique identifier of the workflow

workflowNamestring

The name of the workflow

workflowNameKeystring

The key for the workflow name used for localization

Example response

{
  "workflowId": "123e4567-e89b-12d3-a456-426614174000",
  "workflowName": "Standard Approval Workflow",
  "workflowNameKey": "workflow.standard.approval",
  "approvalStageDetails": [
    {
      "stageId": "123e4567-e89b-12d3-a456-426614174000",
      "stageName": "Under Review",
      "stageNameKey": "workflow.stage.under.review",
      "badgeColor": "#FF9800"
    }
  ]
}