Workflows

Workflow endpoints manage the full lifecycle of workflows in Unstract — including CRUD operations, execution control, endpoint configuration (source/destination connectors), execution monitoring, and file history tracking.

Permissions

• List / Retrieve / Schema / Shared Users: IsOwnerOrSharedUserOrSharedToOrg
• Update / Delete: IsOwner

---

Pagination

All paginated endpoints use page (default 1) and page_size (default 50, max 1000) query parameters and return responses in the format: { count, next, previous, results }.

---

Workflow CRUD

Create, list, retrieve, update, and delete workflows.

GET/api/v1/unstract/{org_id}/workflow/

List all workflows accessible to the current user.▾

POST/api/v1/unstract/{org_id}/workflow/

Create a new workflow. The is_active field is automatically set to true and workflow_owner is set to the requesting user.▾

GET/api/v1/unstract/{org_id}/workflow/{id}/

Retrieve a single workflow by its ID.▾

PUT/api/v1/unstract/{org_id}/workflow/{id}/

Fully update a workflow. Requires IsOwner permission. PATCH is also supported for partial updates.▾

DELETE/api/v1/unstract/{org_id}/workflow/{id}/

Delete a workflow. Requires IsOwner permission. Returns 204 No Content on success.▾

---

Workflow Actions

Execute workflows, manage activation state, check update permissions, clear file markers, and retrieve schemas.

POST/api/v1/unstract/{org_id}/workflow/execute/

Execute a workflow. Accepts multipart/form-data (for file uploads) or JSON. Use execution_action to control flow for multi-step executions.▾

PUT/api/v1/unstract/{org_id}/workflow/active/{id}/

Toggle the active state of a workflow.▾

GET/api/v1/unstract/{org_id}/workflow/{id}/can-update/

Check whether the current user has permission to update the specified workflow.▾

GET/api/v1/unstract/{org_id}/workflow/{id}/clear-file-marker/

Clear the file processing marker for the specified workflow, allowing previously processed files to be re-processed.▾

GET/api/v1/unstract/{org_id}/workflow/schema/

Retrieve the JSON schema for workflow source or destination connector configuration.▾

GET/api/v1/unstract/{org_id}/workflow/{id}/users/

List the users a workflow is shared with, including organization-wide sharing status.▾

---

Workflow Executions

List, retrieve, and inspect execution logs for workflow runs.

GET/api/v1/unstract/{org_id}/workflow/{id}/execution/

List all executions for a specific workflow. Requires IsOwner permission.▾

GET/api/v1/unstract/{org_id}/workflow/execution/{id}/

Retrieve details of a single execution by its ID.▾

GET/api/v1/unstract/{org_id}/workflow/execution/{id}/logs/

Retrieve paginated execution logs. Filter by file execution or log level.▾

---

File History

Track and manage file processing history for workflows. View which files have been processed, their status, and execution counts.

GET/api/v1/unstract/{org_id}/workflow/{workflow_id}/file-histories/

List file histories for a workflow. Supports filtering by status, execution count, and file path prefix.▾

GET/api/v1/unstract/{org_id}/workflow/{workflow_id}/file-histories/{id}/

Retrieve a single file history entry.▾

DELETE/api/v1/unstract/{org_id}/workflow/{workflow_id}/file-histories/{id}/

Delete a single file history entry. Returns 204 No Content on success.▾

POST/api/v1/unstract/{org_id}/workflow/{workflow_id}/file-histories/clear/

Bulk delete file histories matching the specified filters. At least one filter must be provided.▾