GET /v2/list-conversation-flows – Retell AI Retell SDK

List conversation flows with pagination

get/v2/list-conversation-flows

Query parameters

limitinteger

Maximum number of items to return.

sort_order'ascending' | 'descending'

Sort order for results.

pagination_keystring

Pagination key for fetching the next page.

Response

Successfully retrieved conversation flows

pagination_keystring

Pagination key for the next page.

has_moreboolean

Whether more results are available.

Example response

{
  "items": [
    {
      "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.",
      "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",
          "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": [
            {
              "headers": {
                "Authorization": "Bearer 1234567890"
              },
              "query_params": {
                "index": "1",
                "key": "value"
              }
            }
          ],
          "nodes": [
            {
              "id": "collect_info",
              "type": "conversation",
              "instruction": {
                "type": "prompt",
                "text": "Ask the customer for their name and contact information."
              }
            }
          ],
          "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": [
        {
          "headers": {
            "Authorization": "Bearer 1234567890"
          },
          "query_params": {
            "index": "1",
            "key": "value"
          }
        }
      ],
      "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"
            }
          ]
        }
      ]
    }
  ]
}

Changes

Changed in 5 of the 28 revisions of this API.856

May 28, 202640402ca870b912See the full diff
- ○
  added the optional property ///////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////////// to the response with the status
  response-optional-property-added
- ○
  the ////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the ////////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the ////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the ////////////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////////// response's property pattern was changed from ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ to ^(latest|latest_published|(?!(?:latest|latest_published|v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
May 18, 20266342a99901082See the full diff
- ○
  added the optional property ////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
May 8, 20267dd16ddf69d844See the full diff
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/components/items/allOf[ConversationFlowComponent]/nodes/items/oneOf[SubagentNode]/allOf[subschema #3]/tools/items/oneOf[TransferCallTool]/transfer_option/oneOf[subschema #3: Agentic Warm Transfer]/agentic_transfer_config/transfer_agent/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/components/items/allOf[ConversationFlowComponent]/nodes/items/oneOf[TransferCallNode]/allOf[subschema #2]/transfer_option/oneOf[subschema #3: Agentic Warm Transfer]/agentic_transfer_config/transfer_agent/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/nodes/items/oneOf[SubagentNode]/allOf[subschema #3]/tools/items/oneOf[TransferCallTool]/transfer_option/oneOf[subschema #3: Agentic Warm Transfer]/agentic_transfer_config/transfer_agent/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/nodes/items/oneOf[TransferCallNode]/allOf[subschema #2]/transfer_option/oneOf[subschema #3: Agentic Warm Transfer]/agentic_transfer_config/transfer_agent/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  the ////////////////////// response's property pattern was changed from ^[a-z0-9_-]+$ to ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////////////////// response's property pattern was changed from ^[a-z0-9_-]+$ to ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the //////////////// response's property pattern was changed from ^[a-z0-9_-]+$ to ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
- ○
  the ////////////////////// response's property pattern was changed from ^[a-z0-9_-]+$ to ^(latest|(?!(?:v\d+)$)[a-z][a-z0-9_-]{0,19})$ for the status
  response-property-pattern-changed
May 7, 2026f1a0d7c1e36c437See the full diff
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/components/items/allOf[ConversationFlowComponent]/nodes/items/oneOf[AgentSwapNode]/allOf[subschema #2]/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/components/items/allOf[ConversationFlowComponent]/nodes/items/oneOf[SubagentNode]/allOf[subschema #3]/tools/items/oneOf[AgentSwapTool]/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/nodes/items/oneOf[AgentSwapNode]/allOf[subschema #2]/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property allOf[subschema #2]/items/items/allOf[ConversationFlow]/allOf[subschema #2]/nodes/items/oneOf[SubagentNode]/allOf[subschema #3]/tools/items/oneOf[AgentSwapTool]/agent_version list-of-types was widened by adding types integer and string to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the optional property //////////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  removed the gemini-2.5-flash enum value from the //////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the ////////////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the gemini-2.5-flash enum value from the //////////////////////// response property for the response status
  response-property-enum-value-removed
Apr 28, 20261b4a9d84942a1See the full diff
- ○
  endpoint added
  endpoint-added

Full history