QOqomplement
Workflows

List Workflows

Changed on

List all workflows for the current user.

Query Parameters: - workflow_type: Filter by workflow type (extract, fill, split, etc.) - is_template: Filter by template status - is_active: Filter by active status (default: True) - project_id: Filter by Kiwi project. Pass a UUID for that project, __none__ for workflows NOT bound to any project, or omit to list every workflow the user owns regardless of project.

Returns: List of workflows ordered by last updated

get/api/workflows

Request

  • Base URL
    https://api.qomplement.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.qomplement.com/api/workflows
  • Auth
    HTTP bearer

Query parameters

workflow_typestring nullable
is_templateboolean nullable
is_activeboolean nullable
project_idstring nullable
organization_idstring nullable

Response

Successful Response

idstring required
user_idstring required
namestring required
descriptionstring nullable required
workflow_typestring required
nodesobject[] required
edgesobject[] required
is_activeboolean required
is_templateboolean required
last_executed_atstring nullable required
last_execution_statusstring nullable required
execution_countinteger required
created_atstring required
updated_atstring required
metadata_jsonobject required
project_idstring nullable
has_dashboardboolean

Changes

  • 6fe617c112efRevision changes
    • info

      added the new optional query request parameter organization_id

    • info

      added the new optional query request parameter project_id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 7a7c8e2b5afcRevision changes
    • warning

      deleted the query request parameter project_id

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status