Get workflow by ID

Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.

Authorizations

x-api-key

string

header

required

Headers

Authorization

string

required

Bearer token for authentication

Path Parameters

workflowId

string

required

ID of the workflow to retrieve

Response

200 - application/json

_id

string

Unique identifier of the workflow

createdAt

string

Workflow creation timestamp

dataKey

string

Key for accessing workflow data

displayState

enum<string>

Aggregated state for frontend display purposes, combining workflow state with additional runtime states

Available options:

ACTIVE,

ERROR,

PAUSED,

NOT_SUPPORTED,

PREVIEW,

QUEUED,

DRAFT,

SETUP_RUNNING,

RUNNING

finishedAt

string

Last execution completion time

isAdvanced

boolean

Indicates if this is an advanced workflow

limit

integer

Record limit for the workflow

location

object

Location configuration

Show child attributes

location.isoCode

enum<string>

Available options:

DE,

US,

GB,

NL,

CA

location.type

enum<string>

Available options:

auto,

manual

monitoring

object

Monitoring configuration

name

string

Name of the workflow

nextInvocation

string

Next scheduled execution time

notificationConfig

object

Notification settings

protocol

string

Workflow protocol

runCosts

number

Execution cost in credits

runState

string

State of the last execution

schedules

any[]

Scheduled execution configurations

schema

object

Schema configuration

startedAt

string

Last execution start time

state

enum<string>

The actual workflow state stored in the database

Available options:

ACTIVE,

ERROR,

PAUSED,

NOT_SUPPORTED,

PREVIEW,

QUEUED

templateName

string

Name of the associated template

totalRecords

integer

Total number of records processed

updateInterval

string

Update interval configuration

userId

string

ID of the user who owns the workflow