Get a list of workflows

Retrieves a list of workflows with pagination and search capabilities

Authorizations

x-api-key

string

header

required

Query Parameters

search

string

Search term to filter workflows by name or URL

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 state

Available options:

ACTIVE,

ERROR,

PAUSED,

NOT_SUPPORTED

monitoring

enum<string>

Filter workflows by monitoring status

Available options:

true,

false

updateInterval

enum<string>

Filter workflows by update interval

Available options:

HOURLY,

DAILY,

WEEKLY,

MONTHLY

Response

200 - application/json

pagination

object

Show child attributes

pagination.limit

integer

Number of items per page

pagination.page

integer

Current page number

pagination.totalCount

integer

Total number of items across all pages

pagination.totalPages

integer

Total number of pages

workflows

object[]

Show child attributes

workflows._id

string

workflows.createdAt

string

workflows.dataKey

string

workflows.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,

SETUP_RUNNING,

ERROR_SETUP,

DRAFT,

RUNNING

workflows.finishedAt

string

workflows.isAdvanced

boolean

workflows.limit

integer

workflows.location

object

Show child attributes

workflows.location.isoCode

enum<string>

Available options:

DE,

US,

GB,

NL,

CA

workflows.location.type

enum<string>

Available options:

auto,

manual

workflows.name

string

workflows.protocol

string

workflows.runCosts

number

workflows.runState

string

workflows.schema

object

workflows.schemaType

enum<string>

Available options:

DETAIL,

DIRECTORY

workflows.startedAt

string

workflows.state

enum<string>

The actual workflow state stored in the database

Available options:

ACTIVE,

ERROR,

PAUSED,

NOT_SUPPORTED,

PREVIEW,

QUEUED,

SETUP_RUNNING,

ERROR_SETUP

workflows.templateName

string

workflows.totalRecords

integer

workflows.url

string

workflows.userId

string