Skip to main content
POST
/
action
/
list_archives
List archives
curl --request POST \
  --url https://api.livechatinc.com/v3.6/agent/action/list_archives \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "event_types": {
      "values": [
        "message",
        "filled_form"
      ]
    }
  }
}
'
import requests

url = "https://api.livechatinc.com/v3.6/agent/action/list_archives"

payload = { "filters": { "event_types": { "values": ["message", "filled_form"] } } }
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({filters: {event_types: {values: ['message', 'filled_form']}}})
};

fetch('https://api.livechatinc.com/v3.6/agent/action/list_archives', 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.6/agent/action/list_archives",
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([
'filters' => [
'event_types' => [
'values' => [
'message',
'filled_form'
]
]
]
]),
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.6/agent/action/list_archives"

payload := strings.NewReader("{\n \"filters\": {\n \"event_types\": {\n \"values\": [\n \"message\",\n \"filled_form\"\n ]\n }\n }\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.6/agent/action/list_archives")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"event_types\": {\n \"values\": [\n \"message\",\n \"filled_form\"\n ]\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.livechatinc.com/v3.6/agent/action/list_archives")

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 \"filters\": {\n \"event_types\": {\n \"values\": [\n \"message\",\n \"filled_form\"\n ]\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "chats": [
    {
      "id": "PJ0MRSHTDG",
      "users": [
        {
          "id": "smith@example.com",
          "name": "Agent Smith",
          "email": "smith@example.com",
          "type": "agent",
          "present": true,
          "avatar": "https://cdn.livechat-files.com/api/file/avatar.png",
          "visibility": "all"
        }
      ],
      "thread": {
        "id": "K600PKZON8",
        "active": false,
        "user_ids": [
          "smith@example.com"
        ],
        "events": [
          {
            "id": "QBT14H0Y3Y_1",
            "created_at": "2026-06-28T11:45:32.269000Z",
            "visibility": "all",
            "type": "message",
            "properties": {
              "0805e283233042b37f460ed8fbf22160": {
                "event_property": "property_value"
              }
            },
            "text": "Hello there",
            "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": {
            "thread_property": "property_value"
          }
        },
        "access": {
          "group_ids": [
            0
          ]
        },
        "created_at": "2026-06-28T11:44:58.829000Z",
        "previous_thread_id": "K600PKZOM8",
        "next_thread_id": "K600PKZOO8",
        "previous_accessible_thread_id": "K600PKZOM8",
        "next_accessible_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"
          }
        }
      },
      "properties": {
        "0805e283233042b37f460ed8fbf22160": {
          "chat_property": "property_value"
        }
      },
      "access": {
        "group_ids": [
          0
        ]
      },
      "is_followed": false
    }
  ],
  "found_chats": 42,
  "next_page_id": "MTUxNzM5ODEzMTQ5Ng==",
  "previous_page_id": "MTUxNzM5ODEzMTQ5Ng=="
}
Required scopes: or

Authorizations

Authorization
string
header
required

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
filters
object

Archive filters.

highlights
object

Highlight configuration for search query matches.

sort_order
enum<string>
default:desc

asc for oldest chats first, desc for newest chats first.

Available options:
asc,
desc
limit
integer
default:10

Maximum number of records per page.

Required range: 1 <= x <= 100
page_id
string

Pagination token.

Response

200 - application/json

Archived chats.

chats
object[]

Array of chat objects.

found_chats
integer

Total number of found chats.

next_page_id
string

Pagination token for the next page.

previous_page_id
string

Pagination token for the previous page.