Skip to main content
GET
https://app.voxial.pt/api/
/
conversations
/
{uuid}
curl -X GET "https://app.voxial.pt/api/conversations/7c9e6679-7425-40de-944b-e07fc1f90ae7"

{
  "status": true,
  "history": [
    {
      "role": "assistant",
      "content": "Hello! Welcome to our support. How can I help you today?"
    },
    {
      "role": "user",
      "content": "I'd like to schedule a demo"
    },
    {
      "role": "assistant",
      "content": "I'd be happy to help you schedule a demo! I have availability tomorrow at 2 PM or Thursday at 10 AM. Which works better for you?",
      "function_calls": [
        {
          "name": "check_calendar_availability",
          "arguments": {
            "date_range": "next_7_days"
          },
          "result": {
            "available_slots": ["2025-01-10 14:00", "2025-01-12 10:00"]
          }
        }
      ]
    },
    {
      "role": "user",
      "content": "Thursday at 10 AM works for me"
    },
    {
      "role": "assistant",
      "content": "I've scheduled your demo for Thursday, January 12th at 10 AM. You'll receive a calendar invitation shortly. Is there anything specific you'd like us to cover during the demo?",
      "function_calls": [
        {
          "name": "book_appointment",
          "arguments": {
            "datetime": "2025-01-12T10:00:00",
            "title": "Product Demo"
          },
          "result": {
            "success": true,
            "booking_id": "abc123"
          }
        }
      ]
    }
  ]
}
This endpoint retrieves the complete message history of an existing conversation. Use this to display previous messages when resuming a conversation or to review conversation content.

​
Path Parameters

​
uuid
string
required
The unique UUID identifier of the conversation to retrieve

​
Response Fields

​
status
boolean
Indicates whether the request was successful
​
history
array
Array of messages in the conversation, ordered chronologically (oldest first).

​
Error Responses

​
status
boolean
Will be false when an error occurs
​
error
string
Error message. Possible values:
  • Conversation not found - The provided UUID does not match any conversation
curl -X GET "https://app.voxial.pt/api/conversations/7c9e6679-7425-40de-944b-e07fc1f90ae7"

{
  "status": true,
  "history": [
    {
      "role": "assistant",
      "content": "Hello! Welcome to our support. How can I help you today?"
    },
    {
      "role": "user",
      "content": "I'd like to schedule a demo"
    },
    {
      "role": "assistant",
      "content": "I'd be happy to help you schedule a demo! I have availability tomorrow at 2 PM or Thursday at 10 AM. Which works better for you?",
      "function_calls": [
        {
          "name": "check_calendar_availability",
          "arguments": {
            "date_range": "next_7_days"
          },
          "result": {
            "available_slots": ["2025-01-10 14:00", "2025-01-12 10:00"]
          }
        }
      ]
    },
    {
      "role": "user",
      "content": "Thursday at 10 AM works for me"
    },
    {
      "role": "assistant",
      "content": "I've scheduled your demo for Thursday, January 12th at 10 AM. You'll receive a calendar invitation shortly. Is there anything specific you'd like us to cover during the demo?",
      "function_calls": [
        {
          "name": "book_appointment",
          "arguments": {
            "datetime": "2025-01-12T10:00:00",
            "title": "Product Demo"
          },
          "result": {
            "success": true,
            "booking_id": "abc123"
          }
        }
      ]
    }
  ]
}

​
Use Cases

  • Resume conversations: Retrieve history when a user returns to continue a conversation
  • Analytics: Review conversation content for quality assurance
  • Integration: Sync conversation data with your CRM or support system