---
title: "Get Conversations"
method: GET
path: "/v1/convai/conversations"
tags: ["Agents Platform"]
---

# Get Conversations

`GET /v1/convai/conversations`

Get all conversations of agents that user owns. With option to restrict to a specific agent.

## Query parameters

- `cursor` string, nullable — Used for fetching next page. Cursor is returned in the response.
- `agent_id` string, nullable — Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
- `visited_agent_ids` string[], nullable — Filter conversations where any of these agents participated. Can not exceed 50 values.
- `visited_agent_branch_ids` string[], nullable — Filter conversations where any of these agent branches participated. Can not exceed 50 values.
- `call_successful` 'success' | 'failure' | 'unknown'
- `call_start_before_unix` integer, nullable — Unix timestamp (in seconds) to filter conversations up to this start date.
- `call_start_after_unix` integer, nullable — Unix timestamp (in seconds) to filter conversations after to this start date.
- `call_duration_min_secs` integer, nullable — Minimum call duration in seconds.
- `call_duration_max_secs` integer, nullable — Maximum call duration in seconds.
- `rating_max` integer, nullable — Maximum overall rating (1-5).
- `rating_min` integer, nullable — Minimum overall rating (1-5).
- `has_feedback_comment` boolean, nullable — Filter conversations with user feedback comments.
- `user_id` string, nullable — Filter conversations by the user ID who initiated them.
- `evaluation_params` string[], nullable — Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
- `data_collection_params` string[], nullable — Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
- `data_collection_ids` string[], nullable — Data collection field IDs to include in each conversation summary. Repeat param. When omitted, data_collection_results is not returned.
- `evaluation_criteria_ids` string[], nullable — Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned.
- `tool_names` string[], nullable — Filter conversations by tool names used during the call.
- `tool_names_successful` string[], nullable — Filter conversations by tool names that had successful calls.
- `tool_names_errored` string[], nullable — Filter conversations by tool names that had errored calls.
- `main_languages` string[], nullable — Filter conversations by detected main language (language code).
- `page_size` integer — How many conversations to return at maximum. Can not exceed 100, defaults to 30.
- `summary_mode` 'exclude' | 'include' — Whether to include transcript summaries in the response.
- `search` string, nullable — Full-text or fuzzy search over transcript messages
- `conversation_initiation_source` 'unknown' | 'android_sdk' | 'node_js_sdk' | 'react_native_sdk' | 'react_sdk' | 'js_sdk' | 'python_sdk' | 'widget' | 'sip_trunk' | 'twilio' | 'exotel' | 'genesys' | 'audiocodes' | 'swift_sdk' | 'whatsapp' | 'twilio_sms' | 'flutter_sdk' | 'zendesk_integration' | 'slack_integration' | 'telegram_integration' | 'intercom_integration' | 'freshdesk_integration' | 'salesforce_integration' | 'template_preview' | 'genesys_bot_connector' | 'subagent_tool' — Enum representing the possible sources for conversation initiation.
- `text_only` boolean, nullable
- `conversation_product_type` 'agents' | 'speech_engine' — Which product surface owns this agent document.
- `branch_id` string, nullable — Filter conversations by branch ID.
- `version_id` string, nullable — Filter conversations by version ID.
- `parent_conversation_id` string, nullable — Filter conversations by parent conversation ID for subagent conversations.
- `topic_ids` string[], nullable — Filter conversations by topic IDs assigned during topic discovery.
- `exclude_statuses` string[], nullable — Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.
- `tag_ids` string[], nullable — Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints.
- `workflow_node_entered_id` string, nullable — Filter conversations to only those that entered the given node.
- `termination_reasons` string[], nullable — Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.
- `guardrail_types` GuardrailType[], nullable — Filter to conversations where a guardrail of any of these types triggered (metadata.triggered_guardrails.guardrail_type). Repeat param to match any of several.
- `custom_guardrail_names` string[], nullable — Filter to conversations where a custom guardrail with any of these names triggered (metadata.triggered_guardrails.guardrail_name). Only custom guardrails carry a name. Repeat param to match any of several.

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- GetConversationsPageResponseModel
  - `conversations` ConversationSummaryResponseModel[], required
    - `agent_id` string, required
    - `branch_id` string, nullable
    - `version_id` string, nullable
    - `agent_name` string, nullable
    - `conversation_id` string, required
    - `start_time_unix_secs` integer, required
    - `call_duration_secs` integer, required
    - `message_count` integer, required
    - `status` 'initiated' | 'in-progress' | 'processing' | 'done' | 'failed', required
    - `termination_reason` string
    - `call_successful` 'success' | 'failure' | 'unknown', required
    - `call_success_score` number, nullable
    - `transcript_summary` string, nullable
    - `call_summary_title` string, nullable
    - `main_language` string, nullable
    - `conversation_initiation_source` 'unknown' | 'android_sdk' | 'node_js_sdk' | 'react_native_sdk' | 'react_sdk' | 'js_sdk' | 'python_sdk' | 'widget' | 'sip_trunk' | 'twilio' | 'exotel' | 'genesys' | 'audiocodes' | 'swift_sdk' | 'whatsapp' | 'twilio_sms' | 'flutter_sdk' | 'zendesk_integration' | 'slack_integration' | 'telegram_integration' | 'intercom_integration' | 'freshdesk_integration' | 'salesforce_integration' | 'template_preview' | 'genesys_bot_connector' | 'subagent_tool' — Enum representing the possible sources for conversation initiation.
    - `tool_names` string[], nullable
    - `direction` 'inbound' | 'outbound'
    - `rating` number, nullable
    - `sentiment_analysis` ConversationSentimentAnalysis
      - `overall_label` 'positive' | 'neutral' | 'negative', required
      - `overall_sentiment_score` number, required
      - `overall_frustration_score` number, required
      - `min_user_sentiment_score` number, required
      - `max_user_frustration_score` number, required
      - `num_scored_user_turns` integer, required
    - `data_collection_results` object, nullable
    - `evaluation_criteria_results` object, nullable
    - `tag_ids` string[] — Conversation tag ids assigned to this conversation.
  - `next_cursor` string, nullable
  - `has_more` boolean, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/57d56f34628a/schema)
