Retrieve a workflow.
Retrieve details for a version of the workflow.
HTTP
GET https://hostname/v1/workflows/{definitionId}/{version}
Request Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
definitionId |
string | Yes | Identifier for a definition. |
version |
integer | Yes | Definition version. |
Request Body
No request body.
Request Examples
Each example shows how to call this endpoint with the documented method, URL, headers, and request body format.
curl -X GET "/v1/workflows/{definitionId}/{version}" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
fetch("/v1/workflows/{definitionId}/{version}", {
method: "GET",
headers: {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
})
.then(res => res.json())
.then(data => console.log(data));
import json
import requests
url = "/v1/workflows/{definitionId}/{version}"
headers = {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
payload = None
response = requests.get(url, headers=headers)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
body := http.NoBody
req, _ := http.NewRequest("GET", "/v1/workflows/{definitionId}/{version}", body)
req.Header.Set("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body2, _ := io.ReadAll(resp.Body)
fmt.Println(string(body2))
}
Response Parameters
The response returns a WorkflowDetail object. For complete field descriptions and schema definition, see the schema reference.
Response
Behavior: The request completed successfully. Success.
{
"definitionId": "string",
"workspaceId": "string",
"name": "string",
"description": "string",
"state": "string",
"triggerType": "string",
"version": 0,
"createdAt": "string"
}
Behavior: The request contains invalid or missing fields. Review the error details and correct the request before retrying.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}
Behavior: Authentication failed. Verify that your API key and bearer token are present and valid.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}
Behavior: Access is denied. Verify that your account has the required permissions for this operation.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}
Behavior: The requested resource was not found. Verify the identifier in the request path.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}
Behavior: An unexpected error occurred on the server. If the problem persists, contact support.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}
Success responses
Behavior: Success.
Response structure: The response returns a
WorkflowDetail object.
{
"definitionId": "string",
"workspaceId": "string",
"name": "string",
"description": "string",
"state": "string",
"triggerType": "string",
"version": 0,
"createdAt": "string"
}Error responses
What to do: Review path, query, header, and body values. Correct invalid fields and retry the request.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}What to do: Verify credentials or token validity, then resend the request.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}What to do: Verify permissions and access scope for this operation. Contact an administrator if access should be granted.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}What to do: Confirm the resource identifier and endpoint path, then retry with a valid identifier.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}What to do: Retry after a short delay. If the issue persists, collect error identifiers from the payload and contact support.
{
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errorCode": "string"
}