workflow-resource

Gets the workflow by workflow (execution) id

Changed on Oct 10, 2026

get/api/workflow/{workflowId}

Request

Base URL
https://developer.orkescloud.com
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/orkescloud/apis/orkes-conductor-api-server/docs/api/workflow/:workflowId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflowIdstring required

Query parameters

includeTasksboolean

summarizeboolean

Response

correlationIdstring

createTimeinteger

createdBystring

endTimeinteger

eventstring

externalInputPayloadStoragePathstring

externalOutputPayloadStoragePathstring

failedReferenceTaskNamesstring[]

failedTaskNamesstring[]

historyWorkflow[] circular

idempotencyKeystring

inputobject

lastRetriedTimeinteger

outputobject

ownerAppstring

parentWorkflowIdstring

parentWorkflowTaskIdstring

priorityinteger

rateLimitKeystring

rateLimitedboolean

reRunFromWorkflowIdstring

reasonForIncompletionstring

startTimeinteger

taskToDomainobject

updateTimeinteger

updatedBystring

variablesobject

workflowIdstring

workflowNamestring

workflowVersioninteger

Changes

Oct 10, 2026a142cbe9d486 Revision changes
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the required property ////// to the response with the status
- info
  added the required property ////// to the response with the status

Operation history