List workflows with pagination and filters

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns list of workflows

Request URL

https://{serverurl}/intelligence/workflow/api/flow/workflow Copied!

Scope

DesktopCentralCloud.Platform.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/DexViewData.v1+jsonapplication/DexViewData.v1+jsonCopied!

- Query Parameters

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: Workflow.NAME (String).

To search using a single column, provide one value in SEARCH_COLUMN and the corresponding value in SEARCH_VALUE.
Example:
SEARCH_COLUMN=Workflow.NAME
SEARCH_VALUE=Workflow1

Note: The number of values in SEARCH_VALUE must match the number of columns specified in SEARCH_COLUMN.

SEARCH_VALUEstringOptional

Search Values
Provide the search value(s) corresponding to the column(s) specified in the SEARCH_COLUMN parameter. Multiple values must be provided in the same order as the column names.

pagestringOptional

Page number

pageLimitstringOptional

Number of items per page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/workflow/api/flow/workflow \
  --header 'Accept: application/DexViewData.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
viewNamestring

Name of this view

totalRecordsstring

Total number of matching workflow records

startIndexstring

Starting position of records in this page

noOfObjstring

Number of records in this page

dataJSON Array

List of workflow records

Show Sub-Attributes
JSON Object
Show Sub-Attributes
Workflow.WORKFLOW_IDlong

Workflow unique ID

Workflow.NAMEstring

Name of the workflow

Workflow.DESCRIPTIONstring

Description of the workflow

Workflow.CREATED_BYstring

User who created it

Workflow.CREATED_TIMEstring

Date and time when it was created

Workflow.MODIFIED_BYstring

User who last modified the workflow

Workflow.MODIFIED_TIMEstring

Date and time of the last modification

Workflow.STATUSstring

Status of the workflow: 1 = Active, 2 = Inactive, 3 = Draft

WorkflowVersions.WORKFLOW_VERSION_IDlong

Current version ID of the workflow

WorkflowVersions.VERSIONstring

Version number of the workflow

EAWorkFlowExtensionsRel.STATUSstring

How it was created: 0 = Custom, 1 = From template

Sample Response: HTTP 200

Copied!
  {
    "viewName": "string",
    "totalRecords": "string",
    "startIndex": "string",
    "noOfObj": "string",
    "data": [
      {
        "Workflow.WORKFLOW_ID": 0,
        "Workflow.NAME": "string",
        "Workflow.DESCRIPTION": "string",
        "Workflow.CREATED_BY": "string",
        "Workflow.CREATED_TIME": "string",
        "Workflow.MODIFIED_BY": "string",
        "Workflow.MODIFIED_TIME": "string",
        "Workflow.STATUS": "string",
        "WorkflowVersions.WORKFLOW_VERSION_ID": 0,
        "WorkflowVersions.VERSION": "string",
        "EAWorkFlowExtensionsRel.STATUS": "string"
      }
    ]
  }
                
▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.