List messages (timeline)
Returns email and internal_note rows, oldest first (same as in-app ticket timeline). Draft outbound messages are omitted. Optional types filters by comma-separated email and/or internal_note (default: both).
curl -X GET "/api/v1/tickets/example_string/messages?types=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (API key (ixk_...))"
import requests
import json
url = "/api/v1/tickets/example_string/messages?types=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (API key (ixk_...))"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("/api/v1/tickets/example_string/messages?types=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (API key (ixk_...))"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "/api/v1/tickets/example_string/messages?types=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (API key (ixk_...))")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('/api/v1/tickets/example_string/messages?types=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (API key (ixk_...))'
response = http.request(request)
puts response.body
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"direction": "inbound",
"type": "email",
"from_address": "123 Main St",
"to_addresses": "123 Main St",
"cc_addresses": "123 Main St",
"bcc_addresses": "123 Main St",
"send_status": "pending",
"send_error": "example_string",
"body_text": "example_string",
"body_html": "example_string",
"sent_at": "2024-12-25T10:00:00Z",
"created_at": "2024-12-25T10:00:00Z",
"attachments": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"file_name": "John Doe",
"content_type": "example_string",
"size_bytes": 42,
"disposition": "attachment",
"content_id": "example_string"
}
]
}
]
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
/tickets/{id}/messagesAPI key from Settings → API. Pass as Authorization: Bearer <key>
Ticket UUID or ticket_number
Comma-separated: email, internal_note
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (API key (ixk_...)). API key from Settings → API. Pass as Authorization: Bearer <key>
Path Parameters
Ticket UUID or ticket_number
Query Parameters
Comma-separated: email, internal_note
Responses
inboundoutboundemailinternal_noteComma-separated RFC 5322 addresses
pendingsendingsentfailedinline = CID-related part in HTML
attachmentinlineContent-ID for cid: URLs when disposition is inline
Invalid types filter
Problem code unauthorized — missing/invalid Authorization: Bearer, or revoked API key.
Problem code forbidden — workspace has no API access entitlement, or insufficient_scope — read-only API key used for POST/PATCH/DELETE.
Ticket not found
Rate limit exceeded
Last updated 4 weeks ago
Built with Documentation.AI