Get all Conversations
curl --request GET \
--url http://localhost:8080/api/v1/conversations/all \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://localhost:8080/api/v1/conversations/all"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://localhost:8080/api/v1/conversations/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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 := "http://localhost:8080/api/v1/conversations/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/conversations/all")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/all")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"results": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"reference_number": "<string>",
"waiting_since": "2023-11-07T05:31:56Z",
"contact": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>"
},
"inbox_channel": "email",
"inbox_name": "<string>",
"sla_policy_id": 123,
"first_reply_at": "2023-11-07T05:31:56Z",
"last_reply_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"last_message": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"last_message_sender": "contact",
"last_interaction": "<string>",
"last_interaction_at": "2023-11-07T05:31:56Z",
"last_interaction_sender": "contact",
"next_sla_deadline_at": "2023-11-07T05:31:56Z",
"priority_id": 123,
"assigned_user_id": 123,
"assigned_team_id": 123,
"unread_message_count": 123,
"status": "<string>",
"priority": "<string>",
"first_response_deadline_at": "2023-11-07T05:31:56Z",
"resolution_deadline_at": "2023-11-07T05:31:56Z",
"applied_sla_id": 123,
"next_response_deadline_at": "2023-11-07T05:31:56Z",
"next_response_met_at": "2023-11-07T05:31:56Z",
"mentioned_message_uuid": "<string>"
}
],
"total": 123,
"per_page": 123,
"total_pages": 123,
"page": 123
}
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}Conversations
Get all Conversations
Requires the conversations:read_all permission.
GET
/
api
/
v1
/
conversations
/
all
Get all Conversations
curl --request GET \
--url http://localhost:8080/api/v1/conversations/all \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://localhost:8080/api/v1/conversations/all"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://localhost:8080/api/v1/conversations/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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 := "http://localhost:8080/api/v1/conversations/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/conversations/all")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/all")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"results": [
{
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"reference_number": "<string>",
"waiting_since": "2023-11-07T05:31:56Z",
"contact": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>"
},
"inbox_channel": "email",
"inbox_name": "<string>",
"sla_policy_id": 123,
"first_reply_at": "2023-11-07T05:31:56Z",
"last_reply_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"last_message": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"last_message_sender": "contact",
"last_interaction": "<string>",
"last_interaction_at": "2023-11-07T05:31:56Z",
"last_interaction_sender": "contact",
"next_sla_deadline_at": "2023-11-07T05:31:56Z",
"priority_id": 123,
"assigned_user_id": 123,
"assigned_team_id": 123,
"unread_message_count": 123,
"status": "<string>",
"priority": "<string>",
"first_response_deadline_at": "2023-11-07T05:31:56Z",
"resolution_deadline_at": "2023-11-07T05:31:56Z",
"applied_sla_id": 123,
"next_response_deadline_at": "2023-11-07T05:31:56Z",
"next_response_met_at": "2023-11-07T05:31:56Z",
"mentioned_message_uuid": "<string>"
}
],
"total": 123,
"per_page": 123,
"total_pages": 123,
"page": 123
}
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}Authorizations
basicAuthtokenAuth
Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>
Query Parameters
Page number (defaults to 1)
Required range:
x >= 1Number of items per page (defaults to 30, max 500)
Required range:
1 <= x <= 500Sort direction (case-insensitive). Defaults to desc.
Available options:
asc, desc Field to sort by, as model.field. Defaults to conversations.last_message_at.
Available options:
conversations.status_id, conversations.priority_id, conversations.assigned_team_id, conversations.assigned_user_id, conversations.inbox_id, conversations.last_message_at, conversations.last_interaction_at, conversations.last_interaction_sender, conversations.created_at, conversations.waiting_since, conversations.next_sla_deadline_at, conversations.snoozed_until, conversations.sla_policy_id, conversation_statuses.id, conversation_statuses.name, users.email, users.external_user_id, inboxes.channel JSON-encoded filter. Either an array of conditions that are AND-ed, e.g. [{"model":"conversations","field":"status_id","operator":"equals","value":"1"}], or a group {"logic":"AND","rules":[...]} with at most one level of nested groups. Operators: equals, not equals, greater than, less than, set, not set, in, between, contains, ilike, not contains. Filterable fields: conversations (status_id, priority_id, assigned_team_id, assigned_user_id, inbox_id, last_message_at, last_interaction_at, last_interaction_sender, created_at, waiting_since, next_sla_deadline_at, snoozed_until, sla_policy_id, tags), conversation_statuses (id, name), users (email, external_user_id), inboxes (channel).
Was this page helpful?