Skip to main content
GET
/
v1
/
{workspace}
/
workflow
/
{slug}
/
Get Workflow
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/workflow/{slug}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'
{
  "$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": "Nikita",
    "email": "nikita@suprsend.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
  }
}

Authorizations

​
ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

​
workspace
string
required

Workspace slug (staging, production, etc.)

​
slug
string
required

Unique identifier of the workflow. You can get it from workflow settings.

Query Parameters

​
mode
enum<string>
default:draft

Which workflow version to fetch (draft or live). By default, draft version is returned.

Available options:
draft,
live

Response

Successfully retrieved workflow

​
$schema
string<uri>

Schema URL for workflow validation

Example:

"https://schema.suprsend.com/workflow/v1/schema.json"

​
slug
string

Unique identifier for the workflow

Required string length: 1 - 255
Example:

"welcome-sequence"

​
is_enabled
boolean

Whether the workflow is enabled

Example:

true

​
created_at
string<date-time>

When the workflow was created

​
last_executed_at
string<date-time> | null

When the workflow was last executed

​
name
string

Human-readable name of the workflow

Example:

"Welcome Sequence"

​
description
string | null

Description explaining the usecase of the workflow

​
updated_at
string<date-time>

When the workflow was last updated

​
commit_message
string | null

Last commit message

​
hash
string | null

Git-like hash for version tracking

​
status
enum<string>

Current status of the workflow

Available options:
active,
inactive,
draft
​
category
string

Notification category of the workflow. Used to apply category-specific settings and preferences.

Example:

"transactional"

​
tags
string[]

Tags for organizing and filtering workflows in API.

​
ratelimit
object | null

Workflow throttle settings. This is used to limit the number of times a workflow can be executed per user in a given time period.

​
conditions
object[]

Trigger Conditions for workflow execution. Workflow will only be executed if trigger conditions evaluate to true.

​
trigger_type
enum<string>

How the workflow is triggered. You can refer to all trigger types here.

Available options:
event,
dynamic,
api
​
trigger_events
string[]

Events that trigger this workflow. This will be set for trigger_type = event.

​
override_recipients_type
enum<string> | null

Type of recipient override. Define whether to override and run this workflow for user, list of users or a single object.

Available options:
user,
single_object_fields
​
override_recipients_user_expr
string | null

Expression for overriding recipients when override_recipients_type = user.

​
override_recipients_single_object_fields_expr
string | null

Expression for overriding recipients when override_recipients_type = single_object_fields.

​
override_actor_user_expr
string | null

Expression for overriding actor

​
override_tenant_expr
string | null

Expression for overriding tenant

​
active_at
string<date-time>

When the workflow's live version became active. Will be null for draft version.

​
updated_by
object | null

User who last updated the workflow

​
tree
object

Node tree structure of the workflow. Shows the list of all nodes used in the workflow along with their configuration.

​
validation_result
object

Validation status of the workflow

⌘I