API Reference
Conversations Endpoint
List messages and send replies on a ticket.
List messages
GET /tickets/:id/messagesScopes required: messages:read
Query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | number | Results per page (default: 50, max: 200) |
cursor | string | Pagination cursor |
Response:
{
"messages": [
{
"id": "msg_01abc...",
"ticketId": "tkt_01abc...",
"direction": "inbound",
"body": "Hi, my order hasn't arrived yet.",
"authorEmail": "jane@example.com",
"authorName": "Jane Smith",
"isNote": false,
"createdAt": "2025-01-15T10:30:00Z"
}
],
"nextCursor": null
}Message fields:
| Field | Description |
|---|---|
direction | inbound (from customer) or outbound (from agent/AI) |
isNote | true for internal notes not sent to the customer |
authorEmail | Sender's email address |
Send a reply
POST /tickets/:id/messagesScopes required: messages:send
Request body:
{
"body": "Thanks for reaching out! Your order ships tomorrow.",
"isNote": false
}Set isNote: true to create an internal note instead of sending to the customer.
Response: The created message object.
Replies sent via the API are attributed to the API key owner and appear in the conversation thread the same as agent replies.