Get workflow

Retrieve detailed information for a specific workflow by its ID.

GET /api/v1/workflows/{workflow_id}

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetWorkflowRequest

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.workflows.get_workflow(
    request=GetWorkflowRequest(
        workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetWorkflowRequest

async def get_workflow():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.workflows.get_workflow_async(
        request=GetWorkflowRequest(
            workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
        )
    )
    print(response)

asyncio.run(get_workflow())

Response

{
  "id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "name": "my-workflow",
  "workflow_type": "auto",
  "status": "active",
  "source_id": "7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
  "destination_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "schedule": "daily",
  "workflow_nodes": null,
  "template_id": null,
  "reprocess_all": false,
  "created_at": "2026-04-29T10:00:00Z",
  "updated_at": null
}

Path parameters

workflow_id · string · required

The unique identifier of the workflow.

Response

id · string · required

Unique identifier for the workflow.

name · string · required

Workflow name.

workflow_type · string · required

Workflow type: custom or auto.

status · string · required

Workflow state: active, inactive, or paused.

created_at · string · required

ISO 8601 timestamp when the workflow was created.

source_id · string

Source connector ID.

destination_id · string

Destination connector ID.

schedule · string

Repeating run schedule.

workflow_nodes · array

Workflow processing pipeline nodes.

For more information on workflow nodes, see Workflow nodes.

template_id · string

ID of the workflow template used to create this workflow.

reprocess_all · boolean

Whether all documents are reprocessed on every run.

updated_at · string

ISO 8601 timestamp when the workflow was last updated.

cURL

curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetWorkflowRequest

client = UnstructuredClient(
    api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
    server_url=os.getenv("UNSTRUCTURED_API_URL"),
)

response = client.workflows.get_workflow(
    request=GetWorkflowRequest(
        workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
    )
)
print(response)

import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetWorkflowRequest

async def get_workflow():
    client = UnstructuredClient(
        api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
        server_url=os.getenv("UNSTRUCTURED_API_URL"),
    )
    response = await client.workflows.get_workflow_async(
        request=GetWorkflowRequest(
            workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
        )
    )
    print(response)

asyncio.run(get_workflow())

Response

{
  "id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "name": "my-workflow",
  "workflow_type": "auto",
  "status": "active",
  "source_id": "7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
  "destination_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "schedule": "daily",
  "workflow_nodes": null,
  "template_id": null,
  "reprocess_all": false,
  "created_at": "2026-04-29T10:00:00Z",
  "updated_at": null
}