GET
/
chatbots
/
{chatbotId}
/
conversations
curl --request GET \
  --url https://api.chatling.ai/v2/chatbots/{chatbotId}/conversations \
  --header 'Authorization: Bearer <token>'
{
    "status": "success",
    "data": {
        "pages": {
            "current_page": 1,
            "last_page": 11,
            "per_page": 5
        },
        "conversations": [
            {
                "id": "8977617953",
                "contact_id": "qtr89df0-112d-d197-b541-3f8674663246",
                "archived": 0,
                "important": 1,
                "created_at": "2024-06-14T15:45:34+00:00",
                "messages": [
                    {
                        "text": "System variables are predefined variables that contain system information or can be used to perform specific actions. These variables are automatically created by the Builder.",
                        "role": "bot",
                        "is_ai_kb_response": true,
                        "data": {
                            "helpful_value": null,
                            "sources": [
                                {
                                    "type": "webpage",
                                    "title": "Types of variables - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/variables/variable-types"
                                },
                                {
                                    "type": "webpage",
                                    "title": "Sidebar - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/sidebar"
                                },
                                {
                                    "type": "webpage",
                                    "title": "What are variables? - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/variables/what-are-variables"
                                }
                            ]
                        },
                        "created_at": "2024-06-17T16:09:52+00:00"
                    },
                    {
                        "text": "What are system variables",
                        "role": "user",
                        "created_at": "2024-06-17T16:09:45+00:00"
                    },
                    {
                        "text": "**Hello! How can I assist you today?**\n\nIf you have any questions related to our chatbot or services, please feel free to ask. I'm here to help!",
                        "role": "bot",
                        "is_ai_kb_response": true,
                        "data": {
                            "helpful_value": null,
                            "sources": []
                        },
                        "created_at": "2024-06-14T15:45:39+00:00"
                    },
                    {
                        "text": "Hello!",
                        "role": "user",
                        "created_at": "2024-06-14T15:45:34+00:00"
                    }
                ]
            }
        ]
    }
}

​
Request parameters

​
Path

​
chatbotId
string
required

The chatbot ID.

​
Query

​
page
integer
default:"1"

The page number for pagination.

​
sort
string
default:"date_desc"

The sort order. Possible values:

  • date_desc: Sort by date in descending order.
  • date_asc: Sort by date in ascending order.

​
Response

​
status
string

The status of the request. Will be success if the request was successful, otherwise error.

​
data
object
{
    "status": "success",
    "data": {
        "pages": {
            "current_page": 1,
            "last_page": 11,
            "per_page": 5
        },
        "conversations": [
            {
                "id": "8977617953",
                "contact_id": "qtr89df0-112d-d197-b541-3f8674663246",
                "archived": 0,
                "important": 1,
                "created_at": "2024-06-14T15:45:34+00:00",
                "messages": [
                    {
                        "text": "System variables are predefined variables that contain system information or can be used to perform specific actions. These variables are automatically created by the Builder.",
                        "role": "bot",
                        "is_ai_kb_response": true,
                        "data": {
                            "helpful_value": null,
                            "sources": [
                                {
                                    "type": "webpage",
                                    "title": "Types of variables - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/variables/variable-types"
                                },
                                {
                                    "type": "webpage",
                                    "title": "Sidebar - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/sidebar"
                                },
                                {
                                    "type": "webpage",
                                    "title": "What are variables? - Chatling Documentation",
                                    "url": "https://docs.chatling.ai/builder/variables/what-are-variables"
                                }
                            ]
                        },
                        "created_at": "2024-06-17T16:09:52+00:00"
                    },
                    {
                        "text": "What are system variables",
                        "role": "user",
                        "created_at": "2024-06-17T16:09:45+00:00"
                    },
                    {
                        "text": "**Hello! How can I assist you today?**\n\nIf you have any questions related to our chatbot or services, please feel free to ask. I'm here to help!",
                        "role": "bot",
                        "is_ai_kb_response": true,
                        "data": {
                            "helpful_value": null,
                            "sources": []
                        },
                        "created_at": "2024-06-14T15:45:39+00:00"
                    },
                    {
                        "text": "Hello!",
                        "role": "user",
                        "created_at": "2024-06-14T15:45:34+00:00"
                    }
                ]
            }
        ]
    }
}