Get conversations data
POST/rest/report/conversations
Returns conversation-level records whose creation time falls inside the given date
range. The range between from and to must be within 30 days. Conversations are
returned in order of creation time, oldest first.
To fetch the individual messages of these conversations, pass their UUIDs to Get chats data.
Filters
queues and conversationStatus are optional. Requests without them return the same
report as before. When both are sent, a conversation must match both — for example,
open conversations in the Sales queue.
queuesfilters on the conversation's current (latest) queue. A conversation transferred from queue A to queue B is returned when filtering by B, not by A.- Queues that have since been deleted can still be used, so older conversations remain reportable.
- Every queue UUID must belong to your account. If any UUID is not recognised, the request fails and the error lists the UUID(s).
conversationStatusvalues are case sensitive —Openis rejected.- Conversations without a status are only included when
conversationStatusis not sent. - A single value can be sent as a plain string instead of an array, for example
"queues": "<QUEUE_UUID>"or"conversationStatus": "closed".
Errors
| Situation | message |
|---|---|
from or to missing | From date is required. / To date is required. |
| Date range longer than 30 days | Date range has to be within 30 days |
A conversationStatus value is not allowed, or the list is empty | Invalid conversationStatus. Allowed values: initialized, open, assigned, read, responded, closed |
| A queue UUID is not recognised for your account | Unknown queues: <QUEUE_UUID>, ... |
queues is empty or contains a non-text value | Invalid queues |
| More than 50 queues | maximum queues to be queried is 50. |
Request
Responses
- 200
A page of conversation records, oldest first.