> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# List chats

GET https://api.synthflow.ai/v2/chat

Retrieve a list of chats, optionally filtered by agent ID.

Reference: https://docs.synthflow.ai/api-reference/platform-api/chat/list-chats

## Authentication

- `Authorization` header (bearer token, required)

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Query parameters

- `agent_id` (string, optional) — Filter chats by agent ID.
- `limit` (integer, optional, default: 10) — Limit the number of chats to return.
- `cursor` (string, optional) — Cursor to start from.

## Response

### 200

200

- `status` (string, optional) — Whether the request was successful.
- `response` (object, optional)
  - `chats` (list of object, required)
    - `chat_id` (string, required)
    - `chat_status` (enum, required)
      - Allowed values: `ongoing`, `completed`, `cancelled`
    - `start_timestamp` (datetime, required)
  - `has_more` (boolean, required) — Indicates whether there are more chats available.
  - `next_cursor` (string, required) — Cursor to use for pagination to retrieve the next page of results.

## Examples

**Response**

```json
{
  "status": "ok",
  "response": {
    "chats": [
      {
        "chat_id": "019e244b-4220-4448-9fa2-05a54d05200c",
        "chat_status": "ongoing",
        "start_timestamp": {}
      },
      {
        "chat_id": "3bf17be1-1d52-4f02-9e73-e88d3d6c1022",
        "chat_status": "ongoing",
        "start_timestamp": {}
      },
      {
        "chat_id": "893195c1-c640-438b-9761-2e5357b01cb6",
        "chat_status": "ongoing",
        "start_timestamp": {}
      },
      {
        "chat_id": "893195c1-c640-438b-9761-2e5357b01cb7",
        "chat_status": "ongoing",
        "start_timestamp": {}
      },
      {
        "chat_id": "893195c1-c640-438b-9761-2e5357b01cba",
        "chat_status": "ongoing",
        "start_timestamp": {}
      }
    ],
    "has_more": true,
    "next_cursor": "eyJpZCI6Ijg5MzE5NWMxLWM2NDAtNDM4Yi05NzYxLTJlNTM1N2IwMWNiYSJ9"
  }
}
```

**SDK Code**

```python Chat_list-chats_example
import requests

url = "https://api.synthflow.ai/v2/chat"

querystring = {"agent_id":"893195c1-c640-438b-9761-2e5357b01cb8"}

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

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

print(response.json())
```

```go Chat_list-chats_example
package main

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

func main() {

	url := "https://api.synthflow.ai/v2/chat?agent_id=893195c1-c640-438b-9761-2e5357b01cb8"

	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(res)
	fmt.Println(string(body))

}
```

```ruby Chat_list-chats_example
require 'uri'
require 'net/http'

url = URI("https://api.synthflow.ai/v2/chat?agent_id=893195c1-c640-438b-9761-2e5357b01cb8")

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
```

```java Chat_list-chats_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.synthflow.ai/v2/chat?agent_id=893195c1-c640-438b-9761-2e5357b01cb8")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```csharp Chat_list-chats_example
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/chat?agent_id=893195c1-c640-438b-9761-2e5357b01cb8");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Chat_list-chats_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/chat?agent_id=893195c1-c640-438b-9761-2e5357b01cb8")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```