Get workflow definition

GET

/api/admin/workflow/definitions/{id}

const url = 'https://example.com/api/admin/workflow/definitions/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/admin/workflow/definitions/example \
  --header 'Authorization: Bearer <token>'

Retrieves a workflow definition by ID

Authorizations

bearerAuth

Parameters

Path Parameters

required

Definition ID

string

Responses

200

Workflow definition

application/json

object

required

Unique workflow identifier

string

connectionId

required

References parent workflow connection

string

name

required

Human-readable workflow name

string

description

Workflow description

string

processDefinitionKey

External engine process definition key

string

initialTriggerUrl

URL to trigger the start of the workflow

string

Example

{
  "id": "content-approval",
  "connectionId": "camunda-prod",
  "name": "Content Approval",
  "description": "Standard content approval workflow",
  "processDefinitionKey": "content-approval-v1",
  "initialTriggerUrl": "/webhook/12345678-abcd-efgh-ijkl-1234567890ab/start"
}

404

Definition not found

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}

500

Internal server error

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}