GET
/
v1
/
api
/
conversations
/
flow
/
{flowId}
Get Conversations By Flow ID
curl --request GET \
  --url https://api.trillet.ai/v1/api/conversations/flow/{flowId} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "_id": "112ec528bf7946a12ab0fs21",
  "userId": "60d9e3c2f42e4d03800e01a5",
  "pathwayId": "pw12345",
  "agentId": "ag67890",
  "customer": {
      "name": "Test Customer Name",
      "email": "customer@example.com",
      "phone": "+123456789"
    },
  "messages": [
      {
        "direction": "outbound",
        "sent": true,
        "message": "Thank you for your feedback!",
        "status": "approved",
        "_id": "675c8e368824aa5f130b94d3",
        "createdAt": "2024-12-01T08:45:00Z",
        "updatedAt": "2024-12-01T09:00:00Z"
      },
    {
        "direction": "inbound",
        "sent": true,
        "message": "No worries!",
        "status": "received",
        "_id": "675c8e368824aa5f130b94d3",
        "createdAt": "2024-12-01T08:55:00Z",
        "updatedAt": "2024-12-01T09:00:00Z"
      }
  ],
  "createdAt": "2024-12-01T08:45:00Z",
  "updatedAt": "2024-12-03T12:30:00Z"
}

Headers

x-api-key
string
required
API key used for authenticating requests to the API.
x-workspace-id
string
required
Workspace identifier for the API.

Path Parameters

flowId
string
required
The unique identifier of the message flow.

Response Fields

The response body will contain an array of the following fields:
_id
string
The unique identifier for the conversation.
userId
string
The unique identifier for the user associated with the conversation.
pathwayId
string
The unique identifier for the flow associated with the conversation.
agentId
string
The unique identifier for the agent handling the conversation.
customer
object
Customer details associated with the conversation.
customer.name
string
The name of the customer.
customer.email
string
The email address of the customer.
customer.phone
string
The phone number of the customer.
messages
array
An array of messages exchanged in the conversation.
createdAt
string
Timestamp when the conversation was created.
updatedAt
string
Timestamp when the conversation was last updated.
{
  "_id": "112ec528bf7946a12ab0fs21",
  "userId": "60d9e3c2f42e4d03800e01a5",
  "pathwayId": "pw12345",
  "agentId": "ag67890",
  "customer": {
      "name": "Test Customer Name",
      "email": "customer@example.com",
      "phone": "+123456789"
    },
  "messages": [
      {
        "direction": "outbound",
        "sent": true,
        "message": "Thank you for your feedback!",
        "status": "approved",
        "_id": "675c8e368824aa5f130b94d3",
        "createdAt": "2024-12-01T08:45:00Z",
        "updatedAt": "2024-12-01T09:00:00Z"
      },
    {
        "direction": "inbound",
        "sent": true,
        "message": "No worries!",
        "status": "received",
        "_id": "675c8e368824aa5f130b94d3",
        "createdAt": "2024-12-01T08:55:00Z",
        "updatedAt": "2024-12-01T09:00:00Z"
      }
  ],
  "createdAt": "2024-12-01T08:45:00Z",
  "updatedAt": "2024-12-03T12:30:00Z"
}