Skip to main content
GET
/
conversations
/
{conversation}
Get a conversation
curl --request GET \
  --url https://api.example.com/conversations/{conversation}
import requests

url = "https://api.example.com/conversations/{conversation}"

response = requests.get(url)

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

fetch('https://api.example.com/conversations/{conversation}', 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/{conversation}",
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/{conversation}"

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

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

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
{
  "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
}

Path Parameters

conversation
integer
required

Conversation ID

Response

The conversation.

id
integer
Example:

1

type
string

Conversation type: direct or group

Example:

"direct"

title
string

Conversation title (group only)

Example:

""

created_at
integer<int64>

Unix timestamp

updated_at
integer<int64>

Unix timestamp

latest_message
object | null

Latest message in the conversation

mute_rule
integer | null

Mute rule ID or null

unread_message_count
integer
Example:

0

participants
object[]

Conversation participants

publish
object
archived_at
integer<int64> | null

When the auth user archived this conversation