Skip to main content
GET
/
user
/
conversations
curl -X GET "https://call.aiployees.com/api/user/conversations?type=widget&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "current_page": 1,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "widget",
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "whatsapp",
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45"
    }
  ],
  "first_page_url": "https://call.aiployees.com/api/user/conversations?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://call.aiployees.com/api/user/conversations?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://call.aiployees.com/api/user/conversations?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://call.aiployees.com/api/user/conversations?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://call.aiployees.com/api/user/conversations?page=2",
  "path": "https://call.aiployees.com/api/user/conversations",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15,
  "total": 68
}
This endpoint returns a paginated list of conversations belonging to the authenticated user’s assistants. Use this to display conversation history, filter by type, or integrate with your CRM.
This endpoint requires authentication. Pass your API key in the Authorization header as a Bearer token.

​
Query Parameters

​
type
string
Filter conversations by type. Possible values: test, widget, whatsapp, api
​
assistant_id
integer
Filter conversations by assistant ID (must belong to the authenticated user)
​
date_from
string
Filter conversations from this date (YYYY-MM-DD format)
​
date_to
string
Filter conversations until this date (YYYY-MM-DD format)
​
per_page
integer
Number of conversations per page (1-100, default: 15)
​
page
integer
Page number (default: 1)

​
Response Fields

​
data
array
​
current_page
integer
The current page number
​
per_page
integer
Number of items per page
​
total
integer
Total number of conversations matching the criteria
​
last_page
integer
The last page number
curl -X GET "https://call.aiployees.com/api/user/conversations?type=widget&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "current_page": 1,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "widget",
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "whatsapp",
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45"
    }
  ],
  "first_page_url": "https://call.aiployees.com/api/user/conversations?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://call.aiployees.com/api/user/conversations?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://call.aiployees.com/api/user/conversations?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://call.aiployees.com/api/user/conversations?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://call.aiployees.com/api/user/conversations?page=2",
  "path": "https://call.aiployees.com/api/user/conversations",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15,
  "total": 68
}

​
Conversation Types

TypeDescription
testInternal test conversations from the assistant testing interface
widgetConversations from the web chat widget
whatsappWhatsApp Business conversations
apiConversations created via the API

​
Use Cases

  • Analytics Dashboard: Display conversation metrics and trends
  • CRM Integration: Sync conversation data with your customer database
  • Quality Monitoring: Review conversation volumes by type and assistant
  • Billing Review: Track conversation costs across your organization