Skip to main content
GET
/
v2
/
list-conversation-flows
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});

const conversationFlows = await client.conversationFlow.list();

console.log(conversationFlows.has_more);
{
  "pagination_key": "<string>",
  "has_more": true,
  "items": [
    {
      "conversation_flow_id": "<string>",
      "version": 123,
      "model_choice": {
        "type": "cascading",
        "high_priority": true
      },
      "model_temperature": 0.7,
      "tool_call_strict_mode": true,
      "knowledge_base_ids": [
        "kb_001",
        "kb_002"
      ],
      "kb_config": {
        "top_k": 3,
        "filter_score": 0.6
      },
      "start_speaker": "agent",
      "begin_after_user_silence_ms": 2000,
      "global_prompt": "You are a helpful customer service agent.",
      "flex_mode": false,
      "tools": [
        {
          "type": "custom",
          "name": "get_customer_info",
          "description": "Get customer information from database",
          "tool_id": "tool_001",
          "url": "https://api.example.com/customer",
          "method": "GET"
        }
      ],
      "components": [
        {
          "name": "Customer Information Collector",
          "nodes": [
            {
              "id": "collect_info",
              "type": "conversation",
              "instruction": {
                "type": "prompt",
                "text": "Ask the customer for their name and contact information."
              }
            }
          ],
          "flex_mode": false,
          "tools": [
            {
              "type": "custom",
              "name": "get_customer_info",
              "description": "Get customer information from database",
              "tool_id": "tool_001",
              "url": "https://api.example.com/customer",
              "method": "GET"
            }
          ],
          "mcps": [
            {
              "name": "<string>",
              "url": "<string>",
              "headers": {
                "Authorization": "Bearer 1234567890"
              },
              "query_params": {
                "index": "1",
                "key": "value"
              },
              "timeout_ms": 123
            }
          ],
          "start_node_id": "collect_info",
          "begin_tag_display_position": {
            "x": 100,
            "y": 200
          },
          "notes": [
            {
              "id": "note_abc123",
              "content": "Remember to handle edge cases here.",
              "display_position": {
                "x": 300,
                "y": 150
              },
              "size": {
                "width": 200,
                "height": 100
              }
            }
          ]
        }
      ],
      "start_node_id": "start",
      "default_dynamic_variables": {
        "company_name": "Retell Inc",
        "support_hours": "9 AM - 5 PM"
      },
      "begin_tag_display_position": {
        "x": 100,
        "y": 200
      },
      "notes": [
        {
          "id": "note_abc123",
          "content": "Remember to handle edge cases here.",
          "display_position": {
            "x": 300,
            "y": 150
          },
          "size": {
            "width": 200,
            "height": 100
          }
        }
      ],
      "mcps": [
        {
          "name": "<string>",
          "url": "<string>",
          "headers": {
            "Authorization": "Bearer 1234567890"
          },
          "query_params": {
            "index": "1",
            "key": "value"
          },
          "timeout_ms": 123
        }
      ],
      "is_transfer_llm": false,
      "nodes": [
        {
          "id": "start",
          "type": "conversation",
          "instruction": {
            "type": "prompt",
            "text": "Greet the customer and ask how you can help them."
          },
          "edges": [
            {
              "id": "edge_1",
              "transition_condition": {
                "type": "prompt",
                "prompt": "Customer wants to book appointment"
              },
              "destination_node_id": "book_appointment"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Query Parameters

limit
integer
default:50

Maximum number of items to return.

Required range: x <= 1000
sort_order
enum<string>
default:descending

Sort order for results.

Available options:
ascending,
descending
pagination_key
string

Pagination key for fetching the next page.

Response

Successfully retrieved conversation flows

pagination_key
string

Pagination key for the next page.

has_more
boolean

Whether more results are available.

items
object[]