List the conversation messages
The visitor’s conversation history, oldest first, with the sender expanded — this is what the widget renders.
GET
/
api
/
v1
/
widget
/
messages
List the conversation messages
curl --request GET \
--url https://app.tied.com/api/v1/widget/messages \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://app.tied.com/api/v1/widget/messages"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.tied.com/api/v1/widget/messages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://app.tied.com/api/v1/widget/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tied.com/api/v1/widget/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"payload": [
{
"id": 1204,
"content": "Is the Advanced plan month to month?",
"message_type": 0,
"content_type": "text",
"content_attributes": {
"in_reply_to": null
},
"created_at": 1789965102,
"conversation_id": 339,
"sender": {
"additional_attributes": {
"avatar_background_color": "#CCF3EA",
"illustration_avatar_index": 16
},
"custom_attributes": {},
"email": "visitor@example.com",
"id": 266,
"identifier": "EXAMPLE_IDENTIFIER",
"name": "Jamie Visitor",
"phone_number": null,
"thumbnail": "/dashboard/images/default-contact-avatars/016.svg",
"thumbnail_background_color": "#CCF3EA",
"domain_logo_avatar": false,
"customer_verified": true,
"blocked": false,
"type": "contact"
}
}
],
"meta": {
"contact_last_seen_at": 0
}
}{
"error": "Resource could not be found"
}Authorizations
The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.
Query Parameters
The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.
Example:
"EXAMPLE_WEBSITE_TOKEN"
Return messages before this message ID, for paging back through history.
Response
Success
Show child attributes
Show child attributes
Was this page helpful?
⌘I
List the conversation messages
curl --request GET \
--url https://app.tied.com/api/v1/widget/messages \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://app.tied.com/api/v1/widget/messages"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.tied.com/api/v1/widget/messages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://app.tied.com/api/v1/widget/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tied.com/api/v1/widget/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"payload": [
{
"id": 1204,
"content": "Is the Advanced plan month to month?",
"message_type": 0,
"content_type": "text",
"content_attributes": {
"in_reply_to": null
},
"created_at": 1789965102,
"conversation_id": 339,
"sender": {
"additional_attributes": {
"avatar_background_color": "#CCF3EA",
"illustration_avatar_index": 16
},
"custom_attributes": {},
"email": "visitor@example.com",
"id": 266,
"identifier": "EXAMPLE_IDENTIFIER",
"name": "Jamie Visitor",
"phone_number": null,
"thumbnail": "/dashboard/images/default-contact-avatars/016.svg",
"thumbnail_background_color": "#CCF3EA",
"domain_logo_avatar": false,
"customer_verified": true,
"blocked": false,
"type": "contact"
}
}
],
"meta": {
"contact_last_seen_at": 0
}
}{
"error": "Resource could not be found"
}