Get conversation

Returns the current state and message history of a specific conversation.

GET https://api.platica.mx/v1/conversations/{id}

URL parameters

ParameterTypeDescriptionRequired
idstringUnique identifier of the conversation: the id field returned by the listings. See How IDs work

Legacy lookup (deprecated)

Query parameterTypeDescriptionRequired
channelIdstringOnly applies to the legacy lookup: narrows by channel when multiple conversations share the same conversationId

Response

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte General",
      "conversationsCount": 1,
      "conversations": [
        {
          "id": "conv_001",
          "conversationId": "987654321098",
          "clientId": "client_123",
          "agentId": "agent_001",
          "source": null,
          "canSendDirectMessage": true,
          "workspaceId": "ws_001",
          "channelId": "channel_001",
          "contactName": "Juan Pérez",
          "phoneNumber": "1234567890",
          "topic": "Consulta General",
          "platform": "whatsapp",
          "owners": [
            "soporte@empresa.com"
          ],
          "tags": [
            "prioridad-alta"
          ],
          "creationDate": "2025-03-15T10:00:00Z",
          "lastUpdate": "2025-03-15T10:15:00Z",
          "status": "active",
          "operation": "assistance",
          "messageCount": 4,
          "messages": [
            {
              "content": "Hola, necesito información sobre sus servicios.",
              "contentType": "text",
              "creationDate": "2025-03-15T09:58:00Z",
              "direction": "incoming",
              "files": [],
              "id": "msg_001",
              "images": [],
              "owner": {
                "id": "user_001"
              },
              "lastUpdate": "2025-03-15T09:58:00Z",
              "role": "user",
              "status": "received"
            },
            {
              "content": "Hola, ¿cómo puedo ayudarte hoy?",
              "contentType": "text",
              "creationDate": "2025-03-15T10:00:00Z",
              "direction": "outgoing",
              "files": [],
              "id": "msg_002",
              "images": [],
              "owner": {
                "id": "agent_001"
              },
              "lastUpdate": "2025-03-15T10:00:00Z",
              "role": "assistant",
              "status": "delivered"
            },
            {
              "content": "Tengo una duda sobre el producto que compré.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:05:00Z",
              "direction": "incoming",
              "files": [],
              "id": "msg_003",
              "images": [],
              "owner": {
                "id": "user_001"
              },
              "lastUpdate": "2025-03-15T10:05:00Z",
              "role": "user",
              "status": "received"
            },
            {
              "content": "Gracias por tu consulta. Te ayudaré con eso.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:10:00Z",
              "direction": "outgoing",
              "files": [],
              "id": "msg_004",
              "images": [],
              "owner": {
                "id": "agent_001"
              },
              "lastUpdate": "2025-03-15T10:10:00Z",
              "role": "assistant",
              "status": "delivered"
            }
          ]
        }
      ]
    }
  ]
}
FieldDescription
idUnique, canonical document ID of the conversation. Use it in GET and PATCH /v1/conversations/{id}
conversationIdChat thread ID. It uses the chat_* format in the Chat API and does not identify the client
clientIdID of the client attributed to the conversation
agentIdPrincipal agent ID; temporary delegation to a subagent does not change it
sourceInternal origin when available (for example api_chat); may be null for legacy conversations
canSendDirectMessageCan only be false on WhatsApp, Instagram, and Messenger/Facebook; calculated from the latest user message. Always true for internal Platica chats
workspaceIdID of the workspace the conversation belongs to
channelIdCommunication channel ID
contactNameContact/customer name
phoneNumberCustomer phone number
topicConversation topic or subject
platformMessaging platform (whatsapp, instagram, facebook, email, platica, etc.)
ownersList of responsible-user emails
tagsTags associated with the conversation
statusOperational stage: initiated, active, finished, spam, or expired
operationConversation operation mode
messageCountStored thread count; may include internal events not visible in messages
messagesNormalized history available to the integration
creationDateCreation date in ISO 8601 format
lastUpdateLast update date in ISO 8601 format
FieldDescription
idUnique identifier of the message
contentMessage content
contentTypeContent type: text, image, audio, etc.
creationDateMessage creation date and time
directionDirection of the message: incoming or outgoing
filesList of files attached to the message
imagesList of images attached to the message
lastUpdateDate the message was last updated
ownerObject with minimal sender information. Currently includes id when available
roleSender role: user (customer) or assistant (agent/AI)
statusMessage status: received, delivered, read, failed