Skip to main content
GET
Get a list of workflows

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

Search term to filter workflows by name or workflow ID

skip
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:25

Maximum number of items to return

Required range: x >= 1
state
enum<string>

Filter workflows by persisted workflow state. DRAFT workflows are excluded from default results unless explicitly requested. Use inSupport param to filter by support status.

Available options:
ACTIVE,
DRAFT,
PAUSED,
PREVIEW,
QUEUED,
SETUP,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
NOT_SUPPORTED,
ERROR,
DELETED
runState
enum<string>

Filter workflows by latest job run state (e.g., FAILED)

Available options:
FAILED,
FINISHED,
RUNNING
displayState
enum<string>

Filter workflows by computed display state (comma-separated for multiple)

Available options:
ACTIVE,
DRAFT,
PAUSED,
PREVIEW,
FAILED,
RUNNING,
VALIDATING,
PENDING_START,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED
inSupport
enum<string>

Filter workflows by support status (has open support request)

Available options:
true,
false
tags
string[]

Filter workflows by tags. Accepts repeated params, comma-separated values, or a JSON array.

statusFilters
string[]

Dashboard status filters. Accepts repeated params, comma-separated values, or a JSON array.

userId
string[]

Filter workflows by one or more user IDs. Accepts repeated params, comma-separated values, or a JSON array.

channelId
string[]

Filter workflows by one or more notification channel IDs. Accepts repeated params, comma-separated values, or a JSON array.

monitoring
enum<string>

Filter workflows by monitoring status

Available options:
true,
false
updateInterval
enum<string>

Filter workflows by update interval. REAL_TIME matches workflows that run in real time (independent of notifications).

Available options:
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
REAL_TIME
scheduleType
enum<string>

Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled).

Available options:
RUN_ONCE,
RECURRING
templateId
string[]

Filter to workflows instantiated from one or more template IDs. Accepts repeated params, comma-separated values, or a JSON array.

includeDeleted
enum<string>
default:false

Include deleted workflows (for compliance officers)

Available options:
true,
false
format
enum<string>
default:json

Response format (json or csv for export)

Available options:
json,
csv

Response

Successfully retrieved workflows

workflows
object[]

List of workflows

pagination
object

Pagination information