trama.

List conversations

Returns the organization's conversations, most recent message first.

GET
/v1/conversations

Returns the organization's conversations, most recent message first.

Authorization

AuthorizationBearer <token>

The organization API key, sent as Authorization: Bearer <key>.

In: header

Query Parameters

limit?integer

How many items to return. Maximum 100.

Range1 <= value <= 100
Default25
offset?|

How many items to skip from the beginning.

Range0 <= value
Default0
activityState?string
Length1 <= length
channel?string
Length1 <= length
customerId?string
Length1 <= length
query?string

Matches against the contact name and the channel identifier.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/conversations"
{  "data": [    {      "activityState": "string",      "channel": "string",      "contact": "string",      "contactName": "string",      "controlledBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "customerId": "string",      "customerName": "string",      "id": "string",      "language": "string",      "lastMessageAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "limit": 0,    "offset": 0,    "total": 0  }}

Archive a customer DELETE

ARCHIVES the customer: they leave the active book and the listings, but their history is not destroyed. Deliberate — a buggy integration should not be able to wipe an agency's customer base.

Get the transcript of a conversation GET

Oldest first — the order of a transcript, so it reads the way it was spoken. Takes `limit` but no `offset`, and that is deliberate rather than an omission: messages live in two different stores depending on how the channel arrived (WhatsApp, Instagram and Messenger come through the provider; the web chat is handled by the agent runtime), and the reply also stitches together rotated threads. There is no single ordering to offset into, so offering one would return wrong pages. Ask for the number of messages you need.