Skip to main content
GET
/
api
/
v1
/
conversations
List Conversations
curl --request GET \
  --url https://api.example.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

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

Successful Response

Response schema for listing conversations with cursor-based pagination.

​
data
ConversationRead · object[]
required

List of conversations

​
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