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

headerrequired

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

name

string

Name of the workflow

limit

integer

Record limit for the workflow

state

string

Current state of the workflow

userId

string

ID of the user who owns the workflow

updateInterval

string

Update interval configuration

nextInvocation

string

Next scheduled execution time

monitoring

object

Monitoring configuration

notificationConfig

object

Notification settings

createdAt

string

Workflow creation timestamp

schedules

any[]

Scheduled execution configurations

isAdvanced

boolean

Indicates if this is an advanced workflow

finishedAt

string

Last execution completion time

startedAt

string

Last execution start time

protocol

string

Workflow protocol

dataKey

string

Key for accessing workflow data

runCosts

number

Execution cost in credits

runState

string

State of the last execution

totalRecords

integer

Total number of records processed

templateName

string

Name of the associated template

schema

object

Schema configuration