workflows

List Workflows

Changed on

Retrieve a list of workflows, optionally filtered by source, destination, state, name, date range, and supports pagination and sorting.

get/api/v1/workflows/

Request

  • Base URL
    https://platform.unstructuredapp.io
  • URL
    https://platform.unstructuredapp.io/api/v1/workflows/
  • Auth
    none declared

Query parameters

dag_node_configuration_idstring nullable
string uuid
OR
string
string uuid
OR
string
status'active' | 'inactive'
pageinteger nullable
page_sizeinteger nullable
created_sincestring date-time nullable
created_beforestring date-time nullable
namestring nullable
sort_bystring
sort_direction'asc' | 'desc'
show_only_soft_deletedboolean nullable

Headers

unstructured-api-keystring nullable

Response

Successful Response

idstring uuid required
namestring required
keystring nullable
sourcesstring[] required
destinationsstring[] required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom'
status'active' | 'inactive' required
created_atstring date-time required
updated_atstring date-time nullable
reprocess_allboolean
skip_preflightboolean

Example response

[
  {
    "schedule": {
      "crontab_entries": [
        {
          "cron_expression": "0 0 * * *"
        }
      ]
    }
  }
]

Changes