get
List conversations
Retrieves a paginated list of all conversations for the website associated with the API token.
Conversations
| Endpoint | /conversations |
| Method | get |
| Plan Required | FREE |
| Authorization | Bearer Token required |
| Permissions | READ |
| Content-Type | application/json |
/conversationsREAD
application/jsonAPI Tester(Loading...)
Loading API token configuration...
Payload
Query Parameters
pagenumberPage number (1-based)
limitnumberNumber of items per page (max 100)
langstringLanguage code for tag translations (e.g., en, pl, de)
Response
200Paginated list of conversations with summary and localized tags
| Field | Type | Description / Example |
|---|---|---|
data | array | Array of objects (12 properties each) |
| total | number | 150 |
| page | number | 1 |
| limit | number | 20 |
| totalPages | number | 8 |
| hasNextPage | boolean | true |
| hasPrevPage | boolean | No example |
data
Array of objects (12 properties each)
total
150page
1limit
20totalPages
8hasNextPage
truehasPrevPage
No example
401Invalid or missing API token
No response details available
Expected Response
JSON
{
"data": [
{
"id": 123,
"websiteId": 1,
"token": "conv_abc123def456",
"rating": 5,
"assigneeId": 42,
"visitorId": 789,
"visitorTyping": false,
"userTyping": false,
"createdAt": "2024-01-15T10:30:00.000Z",
"status": "OPEN",
"firstMessageAt": "2024-01-15T10:35:00.000Z",
"closedAt": "sample_closedAt"
}
],
"total": 150,
"page": 1,
"limit": 20,
"totalPages": 8,
"hasNextPage": true,
"hasPrevPage": false
}API Access Token
Base URL
https://api.5chat.io