List All Automation Flows via the ChatbotX REST API

Flows are the visual automation building blocks of ChatbotX, defining how your chatbot responds to messages across every connected channel. Use this endpoint to retrieve all flows in your workspace. You can paginate through the results and filter by keyword to find a specific flow by name.

GET /api/v1/flows

Query Parameters

integer

The page number to retrieve. Must be 1 or greater. Defaults to 1.

integer

Number of flows to return per page. Must be 1 or greater.

string

Filter flows by name. Returns all flows whose name contains the provided keyword (case-insensitive).

Code Examples

curl --request GET \
  --url 'https://app.chatbotx.io/api/v1/flows?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/flows"

params = {"page": 1, "perPage": 20}
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/flows?page=1&perPage=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a data array of flow objects.

Response Fields

array

required

Array of flow objects belonging to the workspace.

Show data item fields

string

required

Unique identifier for the flow.

string

required

Display name of the flow.

string

Publication status of the flow, for example active or draft.

string | null

The folder this flow is organised into, or null if it is not in a folder.

string

The ID of the workspace this flow belongs to.

Example Response

{
  "data": [
    {
      "id": "301",
      "name": "Welcome New Subscriber",
      "status": "active",
      "folderId": null,
      "workspaceId": "42"
    },
    {
      "id": "302",
      "name": "Support Triage",
      "status": "draft",
      "folderId": "5",
      "workspaceId": "42"
    }
  ]
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List All Automation Flows via the ChatbotX REST API

Query Parameters

Code Examples

Response

Response Fields

Example Response

​Query Parameters

​Code Examples

​Response

​Response Fields

​Example Response

Query Parameters

Code Examples

Response

Response Fields

Example Response