Skip to main content
GET
/
v1
/
voiceai
/
conversations
List Conversations
curl --request GET \
  --url https://api.example.com/v1/voiceai/conversations \
  --header 'x-api-key: <api-key>'
{
  "conversations": [
    {
      "agent_id": "<string>",
      "conversation_id": "<string>",
      "start_time_unix_secs": 123,
      "call_duration_secs": 123,
      "message_count": 123,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "<string>",
      "agent_name": "<string>",
      "transcript_summary": "<string>",
      "call_summary_title": "<string>",
      "direction": "inbound",
      "rating": 123
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access

Query Parameters

​
cursor
string | null

Used for fetching next page. Cursor is returned in the response.

​
agent_id
string | null

The id of the agent you're taking the action on.

​
call_successful
enum<string> | null

The result of the success evaluation Result of conversation success evaluation

Available options:
success,
failure,
unknown
​
call_start_before_unix
integer | null

Unix timestamp (in seconds) to filter conversations up to this start date.

​
call_start_after_unix
integer | null

Unix timestamp (in seconds) to filter conversations after this start date.

​
call_duration_min_secs
integer | null

Minimum call duration in seconds.

​
call_duration_max_secs
integer | null

Maximum call duration in seconds.

​
rating_min
integer | null

Minimum overall rating (1-5).

Required range: 1 <= x <= 5
​
rating_max
integer | null

Maximum overall rating (1-5).

Required range: 1 <= x <= 5
​
page_size
integer
default:30

How many conversations to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 <= x <= 100
​
summary_mode
enum<string>
default:exclude

Whether to include transcript summaries in the response.

Available options:
exclude,
include

Response

Successful Response

Paginated response for list conversations endpoint.

​
conversations
ConversationSummaryResponseModel · object[]
required

List of conversation summaries

​
has_more
boolean
required

Whether there are more conversations to fetch

​
next_cursor
string | null

Cursor for fetching the next page