Get chat
curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/get_chat \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"chat_id": "PWJ8Y4THAV",
"thread_id": "K600PKZON8"
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/get_chat"
payload = {
"chat_id": "PWJ8Y4THAV",
"thread_id": "K600PKZON8"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({chat_id: 'PWJ8Y4THAV', thread_id: 'K600PKZON8'})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/get_chat', 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.livechatinc.com/v3.7/agent/action/get_chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat_id' => 'PWJ8Y4THAV',
'thread_id' => 'K600PKZON8'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/agent/action/get_chat"
payload := strings.NewReader("{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/agent/action/get_chat")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/get_chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}"
response = http.request(request)
puts response.read_body{
"id": "PJ0MRSHTDG",
"thread": {
"id": "K600PKZON8",
"created_at": "2026-06-07T07:11:28.288340Z",
"active": true,
"user_ids": [
"b7eff798-f8df-4364-8059-649c35c9ed0c",
"smith@example.com"
],
"events": [
{
"id": "Q20N9CKRX2_1",
"created_at": "2026-06-17T07:57:41.512000Z",
"visibility": "all",
"type": "message",
"text": "Hello",
"author_id": "smith@example.com"
}
],
"summary": {
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2026-06-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
}
},
"access": {
"group_ids": [
0
]
},
"previous_thread_id": "K600PKZOM8",
"next_thread_id": "K600PKZOO8",
"customer_visit": {
"ip": "1.2.3.4",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36",
"geolocation": {
"latitude": "-14.6973803",
"longitude": "-75.1266898",
"country": "Poland",
"country_code": "PL",
"region": "Dolnoslaskie",
"city": "Wroclaw",
"timezone": "Europe/Warsaw"
}
}
},
"users": [
{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"type": "customer",
"present": true,
"created_at": "2026-06-17T08:53:20.693553+01:00",
"statistics": {
"chats_count": 1
},
"agent_last_event_created_at": "2026-06-17T09:04:05.239000+01:00"
},
{
"id": "smith@example.com",
"name": "Agent Smith",
"email": "smith@example.com",
"type": "agent",
"present": true,
"avatar": "https://example.com/avatar.jpg",
"visibility": "all"
}
],
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
}
},
"access": {
"group_ids": [
0
]
},
"is_followed": true
}Chats
Get chat
Returns a thread that the current agent has access to in a given chat.
POST
/
action
/
get_chat
Get chat
curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/get_chat \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"chat_id": "PWJ8Y4THAV",
"thread_id": "K600PKZON8"
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/get_chat"
payload = {
"chat_id": "PWJ8Y4THAV",
"thread_id": "K600PKZON8"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({chat_id: 'PWJ8Y4THAV', thread_id: 'K600PKZON8'})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/get_chat', 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.livechatinc.com/v3.7/agent/action/get_chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat_id' => 'PWJ8Y4THAV',
'thread_id' => 'K600PKZON8'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/agent/action/get_chat"
payload := strings.NewReader("{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/agent/action/get_chat")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/get_chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat_id\": \"PWJ8Y4THAV\",\n \"thread_id\": \"K600PKZON8\"\n}"
response = http.request(request)
puts response.read_body{
"id": "PJ0MRSHTDG",
"thread": {
"id": "K600PKZON8",
"created_at": "2026-06-07T07:11:28.288340Z",
"active": true,
"user_ids": [
"b7eff798-f8df-4364-8059-649c35c9ed0c",
"smith@example.com"
],
"events": [
{
"id": "Q20N9CKRX2_1",
"created_at": "2026-06-17T07:57:41.512000Z",
"visibility": "all",
"type": "message",
"text": "Hello",
"author_id": "smith@example.com"
}
],
"summary": {
"status": "ok",
"text": "• Agent greets with a short message.",
"updated_at": "2026-06-21T07:08:16.125000Z"
},
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
}
},
"access": {
"group_ids": [
0
]
},
"previous_thread_id": "K600PKZOM8",
"next_thread_id": "K600PKZOO8",
"customer_visit": {
"ip": "1.2.3.4",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36",
"geolocation": {
"latitude": "-14.6973803",
"longitude": "-75.1266898",
"country": "Poland",
"country_code": "PL",
"region": "Dolnoslaskie",
"city": "Wroclaw",
"timezone": "Europe/Warsaw"
}
}
},
"users": [
{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
"type": "customer",
"present": true,
"created_at": "2026-06-17T08:53:20.693553+01:00",
"statistics": {
"chats_count": 1
},
"agent_last_event_created_at": "2026-06-17T09:04:05.239000+01:00"
},
{
"id": "smith@example.com",
"name": "Agent Smith",
"email": "smith@example.com",
"type": "agent",
"present": true,
"avatar": "https://example.com/avatar.jpg",
"visibility": "all"
}
],
"properties": {
"0805e283233042b37f460ed8fbf22160": {
"string_property": "string_value"
}
},
"access": {
"group_ids": [
0
]
},
"is_followed": true
}Required scopes: or
Authorizations
PersonalAccessTokenOAuth2BearerToken
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
application/json
Response
200 - application/json
Chat with the requested thread.
Chat ID.
Array of user objects (agents and customers).
Show child attributes
Show child attributes
Thread object. For full field details, see the Agent Chat API data structures reference.
Show child attributes
Show child attributes
Custom properties organized by namespace, then property name.
Show child attributes
Show child attributes
Access object defining which groups can access the chat or thread.
Show child attributes
Show child attributes
Whether the chat is followed by the requester.
Was this page helpful?
⌘I