v1

latestOpenAPI 3.0.32026-07-246376162.1 KB
Messaging

Get list of conversations

Returns a paginated list of conversations, ordered from newest to oldest.

get/api/v4/messaging/conversations

Query parameters

limitinteger

The number of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

OK

Example response

{
  "conversations": [
    {
      "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "channel_profile": {
        "id": 12,
        "channel": "whatsapp",
        "identifier": "18885658889",
        "name": "WhatsApp Main (18885658889)"
      },
      "contact_channel_account": {
        "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
        "channel": "whatsapp",
        "identifier": "15551234567",
        "data": {
          "name": "John Smith",
          "username": "johnsmith"
        }
      },
      "user": {
        "id": 1,
        "name": "Jane Doe",
        "email": "jane.doe@contactcenter.com"
      },
      "flow": {
        "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
        "name": "Lead Qualification"
      },
      "queue": {
        "id": 1,
        "name": "Technical Support"
      },
      "status": "active",
      "created_at": "2026-01-15T10:30:00.123000Z",
      "updated_at": "2026-01-20T14:15:00.456000Z"
    }
  ],
  "metadata": {
    "total": 100
  }
}