Get List Of Conversations

curl --request GET \
  --url 'https://api.example.com/api/v1/conversation?api_key='

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/conversation?api_key=', 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/api/v1/conversation?api_key=",
  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/api/v1/conversation?api_key="

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

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/conversation?api_key=")

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": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_name": "<string>",
        "attributes": "<string>",
        "device_type": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "chat_count": 123,
        "widget_type": "<string>",
        "widget_provider": "<string>",
        "first_message": "",
        "includes_voice": false,
        "intent_name": "",
        "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact_first_name": "<string>",
        "contact_last_name": "<string>",
        "summary": "<string>"
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

conversation

Get List Of Conversations

curl --request GET \
  --url 'https://api.example.com/api/v1/conversation?api_key='

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/conversation?api_key=', 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/api/v1/conversation?api_key=",
  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/api/v1/conversation?api_key="

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

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/conversation?api_key=")

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": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_name": "<string>",
        "attributes": "<string>",
        "device_type": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "chat_count": 123,
        "widget_type": "<string>",
        "widget_provider": "<string>",
        "first_message": "",
        "includes_voice": false,
        "intent_name": "",
        "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact_first_name": "<string>",
        "contact_last_name": "<string>",
        "summary": "<string>"
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

query

required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

date_from

string<date>

required

date_to

string<date>

required

assistant_id

string<uuid> | null

intent_id

string<uuid> | null

includes_voice

boolean | null

page

integer

default:1

Required range: x >= 1

size

integer

default:50

Required range: 1 <= x <= 100

Response

Successful Response

data

PageBase[ConversationMetadata] · object

required

Show child attributes

message

string | null

default:""