Skip to main content
GET
/
api
/
v1
/
temporal
/
workflows
/
{workflowId}
/
status
Get Workflow Status
curl --request GET \
  --url https://sandbox.oumla.com/api/v1/temporal/workflows/{workflowId}/status \
  --header 'x-api-key: <api-key>'
{
  "workflowId": "create-collection-123e4567-e89b-12d3-a456-426614174000",
  "runId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "COMPLETED",
  "startTime": "2024-01-01T00:00:00.000Z",
  "historyLength": 42,
  "closeTime": "2024-01-01T00:05:00.000Z",
  "executionTime": 300000,
  "result": {
    "collectionId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "error": {
    "message": "Workflow execution failed",
    "type": "ApplicationFailure"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain your API key from the dashboard.

Headers

​
x-sdk-version
string
default:1.0.0

SDK version header

Path Parameters

​
workflowId
string
required

Temporal workflow ID

Response

Workflow status retrieved successfully

Temporal workflow status data object

​
workflowId
string
required

Temporal workflow ID

Example:

"create-collection-123e4567-e89b-12d3-a456-426614174000"

​
runId
string
required

Temporal workflow run ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
status
enum<string>
required

Workflow status

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED,
TERMINATED,
CONTINUED_AS_NEW,
TIMED_OUT
Example:

"COMPLETED"

​
startTime
string<date-time>
required

Workflow start time in ISO 8601 format

Example:

"2024-01-01T00:00:00.000Z"

​
historyLength
integer
required

Number of events in workflow history

Example:

42

​
closeTime
string<date-time> | null

Workflow close time in ISO 8601 format (null if still running)

Example:

"2024-01-01T00:05:00.000Z"

​
executionTime
integer | null

Workflow execution time in milliseconds (null if still running)

Example:

300000

​
result
object

Workflow result (only present if workflow is completed)

Example:
{
  "collectionId": "123e4567-e89b-12d3-a456-426614174000"
}
​
error
object

Workflow error (only present if workflow failed)