v1

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

Workflow

Get a list of workflows.

Get the list of workflows.

get/api/v2/workflows

Query parameters

page_numberinteger

Example:1

The number of the page requested.

page_size10 | 20 | 30

Example:10

The number of result items in a single response.

namestring

Example:My Workflow

The whole or part of the name of the workflows.

actionTypestring

Example:NotifyByEmail, NotifyBySms

Comma separated action type of this workflow. Possible values are; NotifyByEmail, NotifyBySms, UpdateFindingStatus, OpenTicket and Webhook. When left out, all is implied.

statusstring

Example:Active

Comma separated current status of this workflow. Possible values are; Active, Inactive. When left out, all is implied.

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"
  }
]