Skip to main content
GET
/
api
/
v1
/
conversation
Get List Of Conversations
curl --request GET \
  --url 'https://api.example.com/api/v1/conversation?api_key='
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assistant_name": "<string>",
        "attributes": "<string>",
        "device_type": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "chat_count": 123,
        "widget_type": "<string>",
        "widget_provider": "<string>",
        "first_message": "",
        "includes_voice": false,
        "intent_name": "",
        "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact_first_name": "<string>",
        "contact_last_name": "<string>",
        "summary": "<string>"
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

​
date_from
string<date>
required
​
date_to
string<date>
required
​
assistant_id
string<uuid> | null
​
intent_id
string<uuid> | null
​
includes_voice
boolean | null
​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

​
data
PageBase[ConversationMetadata] · object
required
​
message
string | null
default:""
​
meta
Meta · object