Skip to main content
GET
/
workflows
List workflows
curl --request GET \
  --url https://api.reelevant.com/v2/workflows \
  --header 'Authorization: Bearer <token>'
{
  "paginationCount": 123,
  "paginationPage": 123,
  "paginationLimit": 123,
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "hierarchy": [
        "<string>"
      ],
      "archivedAt": "2023-11-07T05:31:56Z",
      "hidden": true,
      "integrations": [
        {
          "type": "web",
          "id": "<string>",
          "workflowId": "<string>",
          "shortId": "<string>",
          "domain": "<string>",
          "enabled": true,
          "includeContext": true,
          "includeDatalayerPath": [
            "<string>"
          ],
          "waitForEvents": [
            "<string>"
          ],
          "filters": {
            "type": "and",
            "conditions": [
              {
                "operator": "empty",
                "field": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ]
          },
          "code": "<string>",
          "selector": "<string>",
          "emplacement": "replace"
        }
      ],
      "companyId": "<string>",
      "resourceGroupIds": [
        "<string>"
      ],
      "versions": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "definition": {
            "nodes": {},
            "entrypoints": {},
            "edges": {}
          },
          "analyze": {
            "entrypointsByBranches": [
              {
                "branch": "<string>",
                "entrypointIds": [
                  "<string>"
                ]
              }
            ],
            "branches": [
              "<string>"
            ],
            "individualizedBranches": [
              "<string>"
            ],
            "branchesScore": {},
            "defaultBranches": [
              "<string>"
            ],
            "usedDatasourceFields": {},
            "branchesInfos": {},
            "entrypointsPerDataNodeId": {},
            "entrypointsPerPathId": {},
            "entrypointTypes": [
              "<string>"
            ],
            "categoryIdByBranch": {},
            "outputsForEntrypoint": {},
            "datasForEntrypoint": {}
          },
          "metadata": {},
          "analyzeOverrides": {
            "vertexIndividualizedScore": {},
            "customVertexNames": [
              {
                "vertexId": "<string>",
                "name": "<string>"
              }
            ],
            "branchCategoryIds": {}
          },
          "lastSavedBy": "<string>",
          "changeDescription": "<string>",
          "complexityScore": 123
        }
      ],
      "description": "<string>",
      "variableProfileId": "<string>"
    }
  ],
  "code": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
ids
string[]

Filter on workflows ids

​
name
string

Filter on workflows that contains that string in the name

​
resourceGroupIds
string[]

Filter on workflows with on of those resource groups

​
status
enum<string>[]

Filter on workflows with one of those statuses

Available options:
draft,
publishing,
published,
error,
inactive
​
includeArchived
boolean

Display archived workflows

​
includeHidden
boolean

Display hidden workflows

​
sortBy
default:updatedAt
Available options:
name
​
sortOrder
default:desc
Available options:
desc
​
hierarchy
string[]

Filter on workflows with a specific hierarchy path. Pass an array of strings representing the folder path (e.g., ["Marketing", "Q4"] for Marketing > Q4). Empty array or omitted returns root-level workflows (default behavior).

​
select
string[]

List of fields you want to get, by default the whole workflow with versions is returned. But you can choose to return only ['name'] to have data: [{ id: 'bar', name: 'foo' }]. Note: id is always returned

​
page
number
default:1
Required range: x >= 1
​
perPage
number
default:10
Required range: x >= 1
​
entrypointTypes
enum<string>[]
Available options:
email

Response

200 - application/json

Ok

​
paginationCount
number
required
​
paginationPage
number
required
​
paginationLimit
number
required
​
status
enum<string>
required
Available options:
success
​
program
string
required
​
version
string
required
​
datetime
string
required
​
message
string
required
​
data
object[]
required
​
code
number