List Conversations

Returns the conversation history with pagination and filtering options.

GET https://api.platica.mx/v1/conversations

Query parameters

Parameter	Type	Description	Required
`limit`	integer	Maximum number of conversations to return. Default: `50`	—
`offset`	integer	Number of conversations to skip for pagination	—
`channelId`	string	Filter by channel identifier	—
`sortBy`	string	Sort field: `lastUpdate` or `creationDate`	—
`sortDirection`	string	Sort direction: `asc` or `desc`	—
`tags`	array	List of tags to filter by. May be sent as a CSV value in the query string	—
`dateFilter`	object	Filter by specific date or range	—

Specific date:

GET /v1/conversations?dateFilter={"type":"specific","date":"2024-01-15"}

Date range:

GET /v1/conversations?dateFilter={"type":"range","startDate":"2024-01-01","endDate":"2024-01-31"}

Response

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte Técnico",
      "conversations": [
        {
          "id": "conv_001",
          "conversationId": "conv-id-19229",
          "canSendDirectMessage": true,
          "workspaceId": "ws_001",
          "channelId": "channel_001",
          "contactName": "Juan Pérez",
          "phoneNumber": "1234567890",
          "topic": "Problemas técnicos",
          "platform": "whatsapp",
          "status": "active",
          "operation": "automatic",
          "messageCount": 12,
          "messages": [],
          "owners": [
            "soporte@empresa.com"
          ],
          "tags": [
            "vip",
            "soporte"
          ],
          "creationDate": "2025-03-15T10:00:00Z",
          "lastUpdate": "2025-03-15T10:15:00Z"
        }
      ],
      "conversationsCount": 1,
      "pagination": {
        "limit": 50,
        "offset": 0,
        "hasMore": true
      }
    }
  ]
}

Field	Description
`id`	Internal conversation ID
`conversationId`	Public conversation ID (hash or customer phone number)
`canSendDirectMessage`	Indicates whether direct messages can be sent (24-hour window active)
`workspaceId`	ID of the workspace the conversation belongs to
`channelId`	Communication channel ID
`contactName`	Contact/customer name
`phoneNumber`	Customer phone number
`topic`	Conversation topic or subject
`platform`	Messaging platform (`whatsapp`, `telegram`, etc.)
`status`	Conversation status. Can currently be `active`, `finished`, `spam`, or `expired`
`operation`	Conversation operation mode
`messageCount`	Total number of messages
`messages`	List of messages. Usually returned empty in the listing
`owners`	List of responsible-user emails
`tags`	Tags associated with the conversation
`creationDate`	Conversation creation date
`lastUpdate`	Last update date

Field	Description
`limit`	Maximum number of results per page
`offset`	Number of results skipped
`hasMore`	Indicates whether more results are available

Consejo

Use the canSendDirectMessage field to check whether you can send direct messages to a conversation. If it is false, you must start a new conversation using an approved template. See the Messages section for more information.

Previous Get a Conversation Next Update Conversation