from engini import Engini
client = Engini() # reads ENGINI_API_KEY
# one page; list_page also returns total_count. Without top, list() drains every match
page = client.workflows.list_page(name="lead alert", folder_id=7, top=20)
for wf in page.items:
print(wf.workflow_id, wf.name)import { Engini } from "@engini/sdk";
const client = new Engini(); // reads ENGINI_API_KEY
// one page; listPage also returns totalCount. Without top, list() drains every match
const page = await client.workflows.listPage({ name: "lead alert", folderId: 7, top: 20 });
for (const wf of page.items ?? []) console.log(wf.workflowId, wf.name);engini workflows list --name 'lead alert' --folder-id 7 --top 20const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.engini.io/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engini.io/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.engini.io/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engini.io/v1/workflows")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engini.io/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"workflowId": 123,
"name": "<string>",
"type": "<string>",
"enabled": true,
"deleted": true,
"blocked": true,
"consecutiveFailures": 123,
"maxConsecutiveFailures": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": 123,
"name": "<string>"
},
"historyRetentionDays": 123,
"workflowConcurrency": 123,
"applyConcurrencyLimitOnWaitingWorkflow": true,
"stepsCount": 123,
"connections": [
{
"connectionId": 123,
"connectionName": "<string>",
"applicationName": "<string>",
"applicationSlug": "<string>"
}
],
"workspace": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>"
},
"slug": "<string>",
"folderName": "<string>",
"folderId": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"id": 123,
"name": "<string>"
},
"blockReason": "<string>",
"blockedDate": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": {
"id": 123,
"name": "<string>"
},
"lastRunAt": "2023-11-07T05:31:56Z",
"nextRun": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"totalCount": 123,
"offset": 123,
"top": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}List workflows
Returns the workflows in the caller’s account, honoring the optional filters, sort and pagination. Deleted workflows are excluded by default; pass deleted=true to list them, or deletedAfter to list those deleted since a point in time. Work-app flows, table automations, connector-internal flows and business rules are not workflows in this sense and never appear here. An API key pinned to a workspace and environment lists only that scope’s workflows and, with role-based access control on, only those its owner was granted plus public ones; other credentials list the whole account without the role-based filter.
Results are ordered by workflowId descending unless sort says otherwise. Note that updatedAt moves when the workflow is enabled or disabled, so paging under that sort while also updating workflows is not stable.
from engini import Engini
client = Engini() # reads ENGINI_API_KEY
# one page; list_page also returns total_count. Without top, list() drains every match
page = client.workflows.list_page(name="lead alert", folder_id=7, top=20)
for wf in page.items:
print(wf.workflow_id, wf.name)import { Engini } from "@engini/sdk";
const client = new Engini(); // reads ENGINI_API_KEY
// one page; listPage also returns totalCount. Without top, list() drains every match
const page = await client.workflows.listPage({ name: "lead alert", folderId: 7, top: 20 });
for (const wf of page.items ?? []) console.log(wf.workflowId, wf.name);engini workflows list --name 'lead alert' --folder-id 7 --top 20const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.engini.io/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engini.io/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.engini.io/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engini.io/v1/workflows")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engini.io/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"workflowId": 123,
"name": "<string>",
"type": "<string>",
"enabled": true,
"deleted": true,
"blocked": true,
"consecutiveFailures": 123,
"maxConsecutiveFailures": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": 123,
"name": "<string>"
},
"historyRetentionDays": 123,
"workflowConcurrency": 123,
"applyConcurrencyLimitOnWaitingWorkflow": true,
"stepsCount": 123,
"connections": [
{
"connectionId": 123,
"connectionName": "<string>",
"applicationName": "<string>",
"applicationSlug": "<string>"
}
],
"workspace": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>"
},
"slug": "<string>",
"folderName": "<string>",
"folderId": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"id": 123,
"name": "<string>"
},
"blockReason": "<string>",
"blockedDate": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": {
"id": 123,
"name": "<string>"
},
"lastRunAt": "2023-11-07T05:31:56Z",
"nextRun": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"totalCount": 123,
"offset": 123,
"top": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}Query Parameters
Optional sort over workflowId, name, updatedAt, lastRunAt. Comma-separated keys, each "field asc" or "field desc", highest priority first - e.g. "name asc,updatedAt desc". At most 3 keys; a field may appear once; every key needs an explicit direction when there is more than one; nothing may follow workflowId. A single key may omit the direction: workflowId then sorts descending, any other field ascending. Defaults to workflowId desc.
Response
A paginated list of workflows.
Offset-based paginated wrapper for a list of items.