Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Workflow

Get details of a workflow.

Get the details of a workflow identified by its id.

get/api/v2/workflows/{id}

Path parameters

idinteger required

The id of the workflow requested.

Response

Success

WorkflowIdinteger required

The unique identifier of this workflow.

Orderinteger

The order of this workflow.

Namestring

The name of this workflow.

ActionType'NotifyByEmail' | 'NotifyBySms' | 'UpdateFindingStatus' | 'OpenTicket' | 'Webhook'

The action type of this workflow.

Status'Active' | 'Inactive'

The current status of this workflow.

Example response

{
  "WorkflowId": 45,
  "Order": 1,
  "Name": "My Workflow",
  "ActionType": "NotifyByEmail",
  "Status": "Active"
}