List Conversations

List conversations in the current workspace with cursor-based pagination.

Cursor-based pagination is more efficient for large datasets and handles data changes better than offset-based pagination.

Args: cursor: Cursor from previous response for next page (None for first page) limit: Number of items per page (default: 50, max: 100) sort_by: Field to sort by (default: ‘updated_at’) sort_order: Sort order - ‘asc’ or ‘desc’ (default: ‘desc’) status: Optional status filter search: Optional search term for title user_id: Optional user_id filter collection_id: Optional collection_id filter

Returns: ConversationListResponse with conversations, next_cursor, and has_more flag

Examples: First page: GET /conversations?limit=50

Next page (using cursor from previous response): GET /conversations?cursor=conv_xyz123&limit=50

Sort by created_at ascending: GET /conversations?sort_by=created_at&sort_order=asc

Filter by status with sorting: GET /conversations?status=active&sort_by=updated_at&sort_order=desc

GET /api/v1/conversations

List Conversations

cURL

curl --request GET \
  --url https://api.example.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/conversations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "workspace_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "id": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "status": "active",
      "is_public": false,
      "collections": [
        "<string>"
      ],
      "meta_data": {},
      "settings": {},
      "ended_at": "2023-11-07T05:31:56Z",
      "owner_id": "<string>",
      "created_by": "<string>"
    }
  ],
  "total_count": 123,
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Query Parameters

cursor · string | null

Cursor for pagination (use next_cursor from previous response)

limit · integer · default: 50

Number of conversations to return

Required range: 1 <= x <= 100

sort_by · string | null · default: updated_at

Field to sort by (e.g., 'id', 'updated_at', 'created_at', 'title')

sort_order · enum<string> | null · default: desc

Sort order (asc or desc)

Available options: asc, desc

status · string | null

Filter by conversation status

search · string | null

Search conversations by title

user_id · string | null

Filter by user ID

collection_id · string | null

Filter by collection ID

Response

200

application/json

Successful Response

Response schema for listing conversations with cursor-based pagination.

data · ConversationRead · object[] · required

List of conversations

Show child attributes

total_count · integer · required

Number of conversations in this response

has_more · boolean · required

Whether there are more conversations available

next_cursor · string | null

Cursor for the next page