Skip to main content
GET
/
conversations
List conversations
curl --request GET \
  --url https://api.example.com/conversations
import requests

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

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/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/conversations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/conversations"

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

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/conversations")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": 1,
      "type": "direct",
      "title": "",
      "created_at": 123,
      "updated_at": 123,
      "latest_message": {},
      "mute_rule": 123,
      "unread_message_count": 0,
      "participants": [
        {
          "id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "name": "John Doe",
          "title": "Manager",
          "active": true,
          "avatar": {},
          "archived_at": 123,
          "participant_type": "<string>",
          "subtext": "Manager - HQ (Sales)",
          "department": {
            "id": 10,
            "name": "Sales"
          },
          "unit": {
            "id": 5,
            "name": "HQ"
          }
        }
      ],
      "publish": {
        "created_at": 123,
        "updated_at": 123
      },
      "archived_at": 123
    }
  ]
}

Query Parameters

status
enum<string>

Filter by conversation status

Available options:
normal,
archived,
unread
keyword
string

Search in conversation title or participant names

participants
integer[]

Filter by exact set of participant user IDs (finds or excludes conversations with exactly these users)

limit
integer
default:10

Number of items per page (1–100)

page
integer

Page number for pagination

Response

200 - application/json

Paginated list of conversations.

data
object[]