List User Chats

curl --request GET \
  --url https://api.example.com/api/v1/chats/user/{user_id} \
  --header 'X-API-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.example.com/api/v1/chats/user/{user_id}', 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/chats/user/{user_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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/chats/user/{user_id}"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/chats/user/{user_id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

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

{
  "chats": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Support Session",
      "config": {
        "metadata": {
          "department": "technical",
          "priority": "high"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_message_at": "2024-01-15T10:35:00Z",
      "message_count": 5
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Billing Question",
      "config": {
        "metadata": {
          "department": "billing",
          "priority": "low"
        }
      },
      "created_at": "2024-01-14T15:20:00Z",
      "updated_at": "2024-01-14T15:45:00Z",
      "last_message_at": "2024-01-14T15:45:00Z",
      "message_count": 8
    }
  ],
  "total": 15,
  "offset": 0,
  "limit": 50,
  "has_more": false
}

GET

api

chats

user

{user_id}

List User Chats

curl --request GET \
  --url https://api.example.com/api/v1/chats/user/{user_id} \
  --header 'X-API-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.example.com/api/v1/chats/user/{user_id}', 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/chats/user/{user_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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/chats/user/{user_id}"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/chats/user/{user_id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

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

{
  "chats": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Support Session",
      "config": {
        "metadata": {
          "department": "technical",
          "priority": "high"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_message_at": "2024-01-15T10:35:00Z",
      "message_count": 5
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Billing Question",
      "config": {
        "metadata": {
          "department": "billing",
          "priority": "low"
        }
      },
      "created_at": "2024-01-14T15:20:00Z",
      "updated_at": "2024-01-14T15:45:00Z",
      "last_message_at": "2024-01-14T15:45:00Z",
      "message_count": 8
    }
  ],
  "total": 15,
  "offset": 0,
  "limit": 50,
  "has_more": false
}

List User Chats

This endpoint retrieves all chat sessions for a specific user within your tenant.

Authentication

string

required

Authentication header with your tenant’s API key

Path Parameters

string

required

The ID of the user whose chats you want to retrieve

Query Parameters

integer

default:"0"

The number of items to skip before starting to collect results

integer

default:"50"

The maximum number of chats to return

string

default:"desc"

Sort order for chats by creation date. Options: ‘asc’ or ‘desc’

Response

array

Array of chat objects belonging to the user

integer

Total number of chats for this user

integer

Current offset value used for pagination

integer

Current limit value used for pagination

boolean

Indicates if there are more chats available

Chat Object

string

Unique identifier for the chat session

string

The ID of the user who owns this chat

string

The tenant identifier

string

The title of the chat session

object

Configuration object containing metadata and chat settings

string

Timestamp when the chat was created

string

Timestamp when the chat was last updated

string | null

Timestamp of the last message in this chat

integer

Total number of messages in this chat

{
  "chats": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Support Session",
      "config": {
        "metadata": {
          "department": "technical",
          "priority": "high"
        }
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_message_at": "2024-01-15T10:35:00Z",
      "message_count": 5
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "user_id": "user123",
      "tenant_id": "tenant-uuid-here",
      "title": "Billing Question",
      "config": {
        "metadata": {
          "department": "billing",
          "priority": "low"
        }
      },
      "created_at": "2024-01-14T15:20:00Z",
      "updated_at": "2024-01-14T15:45:00Z",
      "last_message_at": "2024-01-14T15:45:00Z",
      "message_count": 8
    }
  ],
  "total": 15,
  "offset": 0,
  "limit": 50,
  "has_more": false
}

Error Responses

400: Bad Request

Invalid query parameters

401: Unauthorized

Invalid or missing API key

404: Not Found

User not found or no chats exist for this user

500: Internal Server Error

Server error processing the request

Example Usage

cURL

curl -X GET "http://localhost:8000/api/v1/chats/user/user123?limit=10&offset=0&order=desc" \
  -H "X-API-Key: your-tenant-api-key"

JavaScript

const userId = 'user123';
const params = new URLSearchParams({
  limit: '10',
  offset: '0',
  order: 'desc'
});

fetch(`http://localhost:8000/api/v1/chats/user/${userId}?${params}`, {
  method: 'GET',
  headers: {
    'X-API-Key': 'your-tenant-api-key'
  }
})
.then(response => response.json())
.then(data => {
  console.log(`Found ${data.total} chats for user`);
  data.chats.forEach(chat => {
    console.log(`Chat: ${chat.title} (${chat.message_count} messages)`);
  });
})
.catch(error => console.error('Error:', error));

Python

import requests

user_id = "user123"
url = f"http://localhost:8000/api/v1/chats/user/{user_id}"
headers = {"X-API-Key": "your-tenant-api-key"}
params = {
    "limit": 10,
    "offset": 0,
    "order": "desc"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()

print(f"Found {data['total']} chats for user {user_id}")
for chat in data['chats']:
    print(f"Chat: {chat['title']} ({chat['message_count']} messages)")

Notes

Results are automatically filtered to only include chats belonging to your tenant
The order parameter sorts chats by their created_at timestamp
last_message_at will be null for chats with no messages
message_count provides a quick way to see chat activity without fetching all messages
Use pagination for users with many chats to improve performance

​List User Chats

​Authentication

​Path Parameters

​Query Parameters

​Response

​Chat Object

​Error Responses

​Example Usage

​cURL

​JavaScript

​Python

​Notes

List User Chats

Authentication

Path Parameters

Query Parameters

Response

Chat Object

Error Responses

Example Usage

cURL

JavaScript

Python

Notes