Skip to main content

Workspace.Workflows.List

Tags: automation, workflows

Endpoints​

Templates​

GET /api/v2/w/{workspace_uuid}/workflows/templates

Description:

Workflow creation and management

List all available workflow templates with feature availability status.

Returns all registered workflow templates including pre-built configurations for common use cases like appointment booking, lead qualification, and customer support. Each template includes availability status based on the workspace's enabled features.

Query Parameters: None

Response: Returns an array of WorkflowTemplateResponse objects, each containing:

  • uuid: Unique template identifier (UUID string)
  • name: Template display name (string)
  • shortDescription: Brief template description (string)
  • longDescription: Detailed template explanation (string)
  • category: Template category (string)
  • requiredFeatures: Array of required feature flags (string array)
  • isAvailable: Whether template can be used in this workspace (boolean)
  • iconName: Icon identifier for UI display (string, nullable)

Permissions: Requires valid workspace membership. All members can view templates, but availability depends on workspace feature flags and subscription level.

Error Responses:

  • 401 Unauthorized: Authentication required or invalid session
  • 403 Forbidden: Member lacks workspace access

Related Endpoints:

  • POST /workflows/templates/{template_uuid}/create-workflow - Create workflow from template
  • GET /workflows - List all workflows
  • POST /workflows - Create a custom workflow

Authorization: Requires workflows:read scope

Response: List of WorkflowTemplateResponse

Create Workflow​

POST /api/v2/w/{workspace_uuid}/workflows/templates/{template_uuid}/create-workflow

Description:

Workflow creation and management

Create a new workflow from a pre-configured template.

Instantiates a workflow based on a registered template, including all associated tasks, assistants, and configurations. Templates provide quick-start solutions for common workflows like appointment scheduling, lead qualification, or customer support. The endpoint validates feature requirements and creates all necessary resources in a single operation.

Path Parameters:

  • template_uuid: Unique identifier of the workflow template (UUID string)

Request Body: Contains workflow creation parameters:

  • name: Display name for the new workflow (required, string)

Response: Returns a WorkflowResponse object with the newly created workflow including:

  • Complete workflow configuration
  • Associated tasks and default task settings
  • Calendar configurations (for scheduling templates)
  • Permissions for the current member

Permissions: Requires valid workspace membership. Template availability depends on workspace feature flags and subscription level. Some templates may require specific enabled features to be instantiated.

Error Responses:

  • 400 Bad Request: Required feature not enabled for template
  • 401 Unauthorized: Authentication required or invalid session
  • 404 Not Found: Template UUID does not exist
  • 500 Internal Server Error: Failed to create workflow or missing dependencies
  • 501 Not Implemented: Template creation not yet implemented for this template type

Related Endpoints:

  • GET /workflows/templates - List available workflow templates
  • GET /workflows - List all workflows
  • GET /workflows/{workflow_id} - Get created workflow details

Authorization: Requires workflows:write scope

Parameters:

Response: See WorkflowResponse