get
Get all tickets for the website
Retrieves paginated tickets for the authenticated website with optional filtering.
Tickets
| Endpoint | /tickets |
| Method | get |
| Plan Required | PRO |
| Authorization | Bearer Token required |
| Permissions | READ |
| Content-Type | application/json |
/ticketsREAD
application/jsonAPI Tester(Loading...)
Loading API token configuration...
Payload
Query Parameters
statusstringFilter by ticket status
prioritystringFilter by priority level
assigneeIdnumberFilter by assigned user ID
visitorIdnumberFilter by visitor ID
searchstringSearch in ticket content
pagenumberPage number (1-based)
limitnumberNumber of tickets per page (max 100)
Response
200Paginated list of tickets
| Field | Type | Description / Example |
|---|---|---|
data | array | Array of tickets matching the query criteriaArray of objects (19 properties each) |
| total | number | 150 |
| page | number | 1 |
| limit | number | 20 |
| totalPages | number | 8 |
| hasNextPage | boolean | true |
| hasPrevPage | boolean | Whether there is a previous page available |
data
Array of tickets matching the query criteriaArray of objects (19 properties each)
total
150page
1limit
20totalPages
8hasNextPage
truehasPrevPage
Whether there is a previous page available
401Unauthorized - Invalid or missing API token
No response details available
Expected Response
JSON
{
"data": [
{
"id": "123456789",
"websiteId": 1,
"visitorId": 1,
"conversationId": 1,
"title": "Login issue with mobile app",
"description": "User cannot login to the mobile app after recent update",
"status": "NEW",
"priority": "MEDIUM",
"assigneeId": 1,
"uniqueEmailAddress": "[email protected]",
"languageCode": "en",
"summary": "Customer experiencing login issues with mobile app after update. Requires technical assistance with account access.",
"createdAt": "2023-12-01T10:00:00Z",
"updatedAt": "2023-12-01T15:30:00Z",
"website": "https://mywebsite.com",
"visitor": {},
"assignee": {},
"messages": "Hello, this is a test message",
"tags": [
"technical-issue",
"mobile-app",
"urgent"
]
}
],
"total": 150,
"page": 1,
"limit": 20,
"totalPages": 8,
"hasNextPage": true,
"hasPrevPage": false
}API Access Token
Base URL
https://api.5chat.io