API ReferenceWorkflows

List workflows

List workflows. scope=accessible (default) returns team-owned plus public/recommended; scope=owned or scope=public filter further.

GET
/api/v1/console/workflows

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Query Parameters

page?number

Page number (1-based)

limit?number

Items per page (max 100)

search?string

Free-text search filter

sort?string

Sort field with optional leading "-" for descending (e.g. "-created_at").

scope?string

Which workflows to return. "accessible" (default) = team-owned + public/recommended; "owned" = team-owned only; "public" = marketplace only.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/console/workflows"
{  "message": "Success",  "meta": {    "total_count": 0,    "page_count": 0,    "current_page": 0,    "limit": 0,    "has_next_page": true,    "has_previous_page": true  },  "data": [    {      "system_prompt": "string",      "rules": [        {          "id": "string",          "name": "string",          "trigger": "string",          "condition": "string",          "response": "string",          "action": "string",          "enabled": true        }      ],      "flows": [        {          "name": "string",          "description": "string",          "category": "support",          "priority": 5,          "is_active": true,          "trigger_keywords": [            {              "keyword": "string",              "weight": "high"            }          ],          "conversation_steps": [            {              "type": "text_response",              "content": "string",              "action": "string",              "followup": "string"            }          ]        }      ],      "tags": [        "string"      ],      "integrations": [        "string"      ],      "channels": [        "string"      ],      "actions": [        "string"      ],      "guide": {        "youtubeUrl": "string",        "steps": [          "Step 1: Configure your store",          "Step 2: Add products"        ]      },      "faq": [        {          "question": "string",          "answer": "string"        }      ],      "setup_steps": [        "string"      ],      "setup_time": 0,      "video_url": "string",      "id": "string",      "name": "string",      "description": "string",      "category": "string",      "visibility": "private",      "is_owner": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}
{  "message": "string",  "error": "string",  "code": "string",  "statusCode": 0,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}