WORKFLOWS
List Workflows
Retrieve a list of workflows in a workspace.
GET
/
v1
/
{workspace}
/
workflow
/
List Workflows
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/workflow/" \
--header 'Authorization: ServiceToken <token>' \
--header 'Content-Type: application/json'import requests
url = "https://management-api.suprsend.com/v1/{workspace}/workflow/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://management-api.suprsend.com/v1/{workspace}/workflow/', 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://management-api.suprsend.com/v1/{workspace}/workflow/",
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: <api-key>"
],
]);
$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://management-api.suprsend.com/v1/{workspace}/workflow/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/workflow/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management-api.suprsend.com/v1/{workspace}/workflow/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 92,
"limit": 10,
"offset": 0
},
"results": [
{
"$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
"slug": "survey-reminder",
"is_enabled": true,
"created_at": "2025-06-27T03:26:48.793551Z",
"last_executed_at": "2025-06-27T04:48:20.653366Z",
"name": "Survey Reminder",
"description": null,
"updated_at": "2025-06-27T03:36:05.623939Z",
"commit_message": "Survey completed",
"hash": "ed3e630c1526170564c962db00dbfcfef997e995f62f67c068a8c9c1d5efbc13",
"status": "active",
"category": "transactional",
"tags": [
"reminder"
],
"ratelimit": null,
"conditions": [],
"trigger_type": "api",
"trigger_events": [],
"override_recipients_type": null,
"override_recipients_user_expr": null,
"override_recipients_single_object_fields_expr": null,
"override_actor_user_expr": null,
"override_tenant_expr": null,
"active_at": "2025-06-27T03:36:05.623845Z",
"updated_by": {
"name": "Jane Doe",
"email": "user@example.com"
},
"tree": {
"nodes": [
{
"name": "Multi-Channel",
"node_type": "send_multi_channel",
"properties": {
"template": "11-performance-review-session",
"channels": [],
"channels_expr": null,
"success": "seen",
"success_is_event": false
},
"description": "",
"schema_version": "1"
}
]
},
"validation_result": {
"is_valid": true
}
}
]
}{
"code": 401,
"error_code": "authentication_failed",
"type": "AuthenticationFailed",
"message": "Invalid service token.",
"detail": "Invalid service token."
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "workspace 'demo' not found",
"detail": "workspace 'demo' not found"
}Authorizations
Pass as Authorization: ServiceToken <token>. You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.
Path Parameters
Workspace slug (staging, production, etc.)
Query Parameters
Mode to filter workflows (draft or live). By default, draft workflows are returned.
Available options:
draft, live Comma-separated list of workflow slugs to filter. This can be used to filter workflows by slug.
Number of workflows to return per page (max 50).
Required range:
x <= 50Number of workflows to skip before starting to return results.
Was this page helpful?
⌘I
List Workflows
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/workflow/" \
--header 'Authorization: ServiceToken <token>' \
--header 'Content-Type: application/json'import requests
url = "https://management-api.suprsend.com/v1/{workspace}/workflow/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://management-api.suprsend.com/v1/{workspace}/workflow/', 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://management-api.suprsend.com/v1/{workspace}/workflow/",
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: <api-key>"
],
]);
$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://management-api.suprsend.com/v1/{workspace}/workflow/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/workflow/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://management-api.suprsend.com/v1/{workspace}/workflow/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"count": 92,
"limit": 10,
"offset": 0
},
"results": [
{
"$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
"slug": "survey-reminder",
"is_enabled": true,
"created_at": "2025-06-27T03:26:48.793551Z",
"last_executed_at": "2025-06-27T04:48:20.653366Z",
"name": "Survey Reminder",
"description": null,
"updated_at": "2025-06-27T03:36:05.623939Z",
"commit_message": "Survey completed",
"hash": "ed3e630c1526170564c962db00dbfcfef997e995f62f67c068a8c9c1d5efbc13",
"status": "active",
"category": "transactional",
"tags": [
"reminder"
],
"ratelimit": null,
"conditions": [],
"trigger_type": "api",
"trigger_events": [],
"override_recipients_type": null,
"override_recipients_user_expr": null,
"override_recipients_single_object_fields_expr": null,
"override_actor_user_expr": null,
"override_tenant_expr": null,
"active_at": "2025-06-27T03:36:05.623845Z",
"updated_by": {
"name": "Jane Doe",
"email": "user@example.com"
},
"tree": {
"nodes": [
{
"name": "Multi-Channel",
"node_type": "send_multi_channel",
"properties": {
"template": "11-performance-review-session",
"channels": [],
"channels_expr": null,
"success": "seen",
"success_is_event": false
},
"description": "",
"schema_version": "1"
}
]
},
"validation_result": {
"is_valid": true
}
}
]
}{
"code": 401,
"error_code": "authentication_failed",
"type": "AuthenticationFailed",
"message": "Invalid service token.",
"detail": "Invalid service token."
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "workspace 'demo' not found",
"detail": "workspace 'demo' not found"
}