Get Conversations By Flow ID

GEThttps://api.trillet.ai/v1/api/conversations/flow/{flowId}

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

flowIdstringrequired

The unique identifier of the message flow.

Response Fields

The response body will contain an array of the following fields:

_idstring

The unique identifier for the conversation.

userIdstring

The unique identifier for the user associated with the conversation.

pathwayIdstring

The unique identifier for the flow associated with the conversation.

agentIdstring

The unique identifier for the agent handling the conversation.

customerobject

Customer details associated with the conversation.

customer.namestring

The name of the customer.

customer.emailstring

The email address of the customer.

customer.phonestring

The phone number of the customer.

messagesarray

An array of messages exchanged in the conversation.

createdAtstring

Timestamp when the conversation was created.

updatedAtstring

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"
}