Skip to main content
GET
/
v2
/
list-conversation-flow-components
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 conversationFlowComponents = await client.conversationFlowComponent.list();

console.log(conversationFlowComponents.has_more);
{
  "pagination_key": "<string>",
  "has_more": true,
  "items": [
    {
      "name": "Customer Information Collector",
      "nodes": [
        {
          "id": "collect_info",
          "type": "conversation",
          "instruction": {
            "type": "prompt",
            "text": "Ask the customer for their name and contact information."
          }
        }
      ],
      "conversation_flow_component_id": "<string>",
      "user_modified_timestamp": 123,
      "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
          }
        }
      ],
      "linked_conversation_flow_ids": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.retellai.com/llms.txt

Use this file to discover all available pages before exploring further.

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 listed conversation flow components

​
pagination_key
string

Pagination key for the next page.

​
has_more
boolean

Whether more results are available.

​
items
object[]