API Reference

Conversations API

Manage customer conversations and retrieve conversation history.

Endpoints

GET/v1/conversations

List conversations with pagination and filters

GET/v1/conversations/:id

Get conversation details with messages

PATCH/v1/conversations/:id

Update conversation status or metadata

POST/v1/conversations/:id/resolve

Mark conversation as resolved

List Conversations

GET /v1/conversations?status=active&agent_id=agent_123&limit=20
{
  "data": [
    {
      "id": "conv_xyz789",
      "agent_id": "agent_123",
      "customer": {
        "id": "cust_456",
        "name": "Rahul Kumar",
        "email": "rahul@example.com",
        "phone": "+919876543210"
      },
      "channel": "whatsapp",
      "status": "active",
      "sentiment": "neutral",
      "messages_count": 8,
      "created_at": "2026-01-12T09:15:00Z",
      "last_message_at": "2026-01-12T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 156,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Query Parameters

  • status - Filter by status: active, resolved, escalated
  • agent_id - Filter by agent
  • channel - Filter by channel: whatsapp, widget, slack
  • customer_id - Filter by customer
  • since - ISO timestamp for start date
  • until - ISO timestamp for end date
  • limit - Results per page (max 100)
  • offset - Pagination offset

Conversation Object

  • id string - Unique identifier
  • agent_id string - Assigned agent
  • customer object - Customer details
  • channel string - Communication channel
  • status string - active, resolved, escalated
  • sentiment string - positive, neutral, negative
  • tags array - Applied tags
  • metadata object - Custom data

Related

Messages API
Analytics API