--- updatedAt: 2026-05-27T12:48:32.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # 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. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Privacy Automation - Assessment Automation", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Assessment Automation APIs provide functionality for managing assessment template lifecycle operations, including template export and import for cross-environment migration, retrieving published template metadata with filtering by template type, and template deletion with comprehensive validation checks." }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Assessments", "description": "The Assessments APIs are used to retrieve assessment data and details.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-assessment-automation.json" }, "x-displayName": "Assessments" } ], "paths": { "/api/assessment/v2/assessments/{assessmentId}/workflows": { "get": { "operationId": "getWorkflowDetailsForAssessmentUsingGET", "summary": "Get Assessment Workflow Stages", "description": "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.\n\n > 🗒 Things to Know \n >\n > - Workflow stage indicates the current stage of the workflow that the assessment is in.\n", "tags": [ "Assessments" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-assessment-automation.json" }, "parameters": [ { "name": "assessmentId", "in": "path", "description": "The unique ID of the assessment to retrieve workflow details for", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "550e8400-e29b-41d4-a716-446655440000" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyAutomation-AssessmentAutomation_WorkflowAndApprovalStageDetails" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "PrivacyAutomation-AssessmentAutomation_OAUTH2": [ "ASSESSMENT_READ", "ASSESSMENT" ] } ] } } }, "components": { "schemas": { "PrivacyAutomation-AssessmentAutomation_WorkflowStageBasicDetails": { "type": "object", "properties": { "stageId": { "description": "The unique identifier of the workflow stage", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "stageName": { "description": "The name of the workflow stage", "type": "string", "example": "Under Review" }, "stageNameKey": { "description": "The key for the stage name used for localization", "type": "string", "example": "workflow.stage.under.review" }, "badgeColor": { "description": "The color code for the badge representing this stage", "type": "string", "example": "#FF9800" } } }, "PrivacyAutomation-AssessmentAutomation_WorkflowAndApprovalStageDetails": { "type": "object", "properties": { "workflowId": { "description": "The unique identifier of the workflow", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "workflowName": { "description": "The name of the workflow", "type": "string", "example": "Standard Approval Workflow" }, "workflowNameKey": { "description": "The key for the workflow name used for localization", "type": "string", "example": "workflow.standard.approval" }, "approvalStageDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PrivacyAutomation-AssessmentAutomation_WorkflowStageBasicDetails" } } } } }, "securitySchemes": { "PrivacyAutomation-AssessmentAutomation_OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "ASSESSMENT": "Access to assessment scope for external systems", "ASSESSMENT_READ": "Access to read assessment scope for external systems" } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "x-onetrust": { "spec-label": "OpenAPI 3.1.0" } } ``` # Sibling pages * [Get List of Assessment Tags](https://developer.onetrust.com/onetrust/reference/gettagsusingget.md) * [Get List of Assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget.md) * [Export Deleted Assessment Audit Log](https://developer.onetrust.com/onetrust/reference/getassessmentdeletelogsusingget.md) * [Get List of Assessment Results](https://developer.onetrust.com/onetrust/reference/getassessmentresultsusingget.md) * [Get List of Linked Assessments](https://developer.onetrust.com/onetrust/reference/getlinkedassessmentsinformationusingget.md) * [Get Assessment](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget.md) * [Get List of Assessments by Criteria](https://developer.onetrust.com/onetrust/reference/getassessmentsusingpost.md) * [Get Assessment Record](https://developer.onetrust.com/onetrust/reference/getassessmentrecordusingget.md) * [Get Assessment Score Profiles](https://developer.onetrust.com/onetrust/reference/getassessmentscoreprofileswithquestionbreakdownusingget.md) * [Get Assessment Comments](https://developer.onetrust.com/onetrust/reference/getcommentsforassessmentusingget.md) * [Create Assessment Comment](https://developer.onetrust.com/onetrust/reference/createcommentusingpost.md)