Skip to main content
GET
Get a workflow

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Path Parameters

workflowId
string
required

Response

publicId
string
required
key
string
required
name
string
required
description
string | null
required
status
enum<string>
required
Available options:
active,
paused
type
enum<string>
required
Available options:
automation,
broadcast
channels
object
required

Settings for each channel this workflow sends on.

steps
object[]
required
triggers
object[]
required
exitConditions
object[]
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
sentCount
number
required
failedCount
number
required
skippedCount
number
required
pendingCount
number
required
bouncedCount
number
required
hardBounceCount
number
required
softBounceCount
number
required
successRate
number | null
required
editUrl
string

Link to edit this workflow's emails in the web editor. Share it when someone wants to tweak the copy or preview an email.