Skip to main content
GET
/
api
/
v1
/
chatflows
List Chatflows
curl --request GET \
  --url https://api.example.com/api/v1/chatflows
{
  "400": {},
  "401": {},
  "403": {},
  "500": {},
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "flowData": "<string>",
      "deployed": true,
      "isPublic": true,
      "apikeyid": "<string>",
      "chatbotConfig": "<string>",
      "apiConfig": "<string>",
      "type": "<string>",
      "category": "<string>",
      "workspaceId": "<string>",
      "createdDate": "<string>",
      "updatedDate": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "pages": 123
}

​
Authentication

This endpoint requires authentication. You must include your API key in the request headers or be authenticated via session.
Required permissions: chatflows:view, chatflows:update, agentflows:view, or agentflows:update

​
Query Parameters

​
type
string
Filter chatflows by type. Valid values:
  • CHATFLOW - Standard chatflows
  • AGENTFLOW - Agent-based flows
  • MULTIAGENT - Multi-agent flows
  • ASSISTANT - Assistant flows
​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"20"
Number of items per page

​
Response

​
data
array
Array of chatflow objects
​
id
string
Unique identifier (UUID) for the chatflow
​
name
string
Name of the chatflow
​
flowData
string
JSON string containing the flow configuration and nodes
​
deployed
boolean
Whether the chatflow is currently deployed
​
isPublic
boolean
Whether the chatflow is publicly accessible
​
apikeyid
string
Associated API key ID for the chatflow
​
chatbotConfig
string
JSON string containing chatbot configuration settings
​
apiConfig
string
JSON string containing API configuration
​
type
string
Type of the chatflow (CHATFLOW, AGENTFLOW, MULTIAGENT, ASSISTANT)
​
category
string
Category classification for the chatflow
​
workspaceId
string
ID of the workspace that owns this chatflow
​
createdDate
string
ISO 8601 timestamp of creation
​
updatedDate
string
ISO 8601 timestamp of last update
​
total
integer
Total number of chatflows matching the filter
​
page
integer
Current page number
​
pages
integer
Total number of pages

​
Example Request

cURL
curl -X GET "https://your-flowise-instance.com/api/v1/chatflows?type=CHATFLOW&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
JavaScript
const response = await fetch('https://your-flowise-instance.com/api/v1/chatflows?type=CHATFLOW', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();
Python
import requests

response = requests.get(
    'https://your-flowise-instance.com/api/v1/chatflows',
    params={'type': 'CHATFLOW', 'page': 1, 'limit': 10},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

​
Example Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Customer Support Bot",
      "flowData": "{\"nodes\":[...],\"edges\":[...]}",
      "deployed": true,
      "isPublic": false,
      "apikeyid": "abc123",
      "chatbotConfig": "{\"welcomeMessage\":\"Hello!\"}",
      "apiConfig": null,
      "type": "CHATFLOW",
      "category": "Support",
      "workspaceId": "workspace-123",
      "createdDate": "2024-01-15T10:30:00.000Z",
      "updatedDate": "2024-01-20T14:45:00.000Z"
    }
  ],
  "total": 25,
  "page": 1,
  "pages": 3
}

​
Error Responses

​
401
error
Unauthorized - Invalid or missing API key
​
403
error
Forbidden - Insufficient permissions to view chatflows
​
400
error
Bad Request - Invalid chatflow type specified
​
500
error
Internal Server Error - An error occurred while fetching chatflows

Build docs developers (and LLMs) love

Get started for freeTalk to us