Skip to main content
GET
/
all
/
conversations
Get Conversations
curl --request GET \
  --url https://public.watermelon.ai/api/v1/all/conversations \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "caller_id": 123,
    "user_id": 123,
    "service": "webchat",
    "webchat_socket_channel": "<string>",
    "new": true,
    "is_closed": true,
    "archived": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "chatbot_enabled": true,
    "no_matches_count": 123,
    "out_of_office_replied": true,
    "company_id": 123,
    "team_id": 123,
    "messages": [
      {
        "id": 123,
        "conversation_id": 123,
        "user_id": 123,
        "payload": "<string>",
        "new": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "read": true
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

The page number

Required range: x >= 0
​
limit
integer
default:25

The numbers of items per page.

Required range: 1 <= x <= 100
​
from
string<date-time>

The begin of the date range

​
to
string<date-time>

The end of the date range

Response

Conversations retrieved

​
id
integer
Example:

1

​
caller_id
integer
​
user_id
integer
​
service
enum<string>
Available options:
telegram,
facebook,
mail,
webchat,
twitter,
whatsapp
Example:

"webchat"

​
webchat_socket_channel
string
​
new
boolean
​
is_closed
boolean
​
archived
string<date-time>
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time>
​
chatbot_enabled
boolean
​
no_matches_count
integer
​
out_of_office_replied
boolean
​
company_id
integer
​
team_id
integer
​
messages
object[]