Sign in
latestOpenAPI 3.1.02026-08-06236494759.4 KB

7be21448a2b3

Workflows

Search Workflows

Endpoint to search Workflows.

get/business/v2/workflows

Query parameters

statusWorkflowStatusSearch[]

The status of the Workflow.

The status of the Workflow.

targetTypesWorkflowTargetType[]

The type of the Workflow.

The type of the Workflow.

textstring

A simple text to search Workflow by name or description.

Example:Workflow

A simple text to search Workflow by name or description.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

0

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing Workflows.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "Workflow",
      "description": "My Workflow Description",
      "steps_count": 1
    }
  ]
}