Skip to main content
GET
/
api
/
v1
/
workflows
List Workflows
curl --request GET \
  --url https://platform.unstructuredapp.io/api/v1/workflows/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "sources": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "destinations": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "workflow_nodes": [
      {
        "name": "<string>",
        "type": "<string>",
        "subtype": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "settings": {}
      }
    ],
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "workflow_type": "basic",
    "schedule": {
      "crontab_entries": [
        {
          "cron_expression": "0 0 * * *"
        }
      ]
    },
    "updated_at": "2023-11-07T05:31:56Z",
    "reprocess_all": false
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
unstructured-api-key
string | null

Query Parameters

​
dag_node_configuration_id
string | null
​
source_id
string<uuid> | null
​
destination_id
string<uuid> | null
​
status
enum<string> | null
Available options:
active,
inactive
​
page
integer | null
default:1
​
page_size
integer | null
default:20
​
created_since
string<date-time> | null
​
created_before
string<date-time> | null
​
name
string | null
​
sort_by
string
default:id
​
sort_direction
enum<string>
default:asc
Available options:
asc,
desc
​
show_only_soft_deleted
boolean | null
default:false
​
show_recommender_workflows
boolean | null
default:false

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
sources
string<uuid>[]
required
​
destinations
string<uuid>[]
required
​
workflow_nodes
WorkflowNode · object[]
required
​
status
enum<string>
required
Available options:
active,
inactive
​
created_at
string<date-time>
required
​
workflow_type
enum<string> | null
Available options:
basic,
advanced,
platinum,
custom,
template
​
schedule
WorkflowSchedule · object
Example:
{
  "crontab_entries": [{ "cron_expression": "0 0 * * *" }]
}
​
updated_at
string<date-time> | null
​
reprocess_all
boolean
default:false