Get Ticket List
Retrieve all ticket data in bulk.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/tickets |
| Options | userId, ticketNo, createdBy, dateFrom, dateTo, dateField, start, limit |
| Body | /N/A |
| Response | |
| Body | Array of email objects, encoded in JSON. |
Request
Resource parameters
Optional
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| start | integer | no | Specifies the offset of the first ticket. Possible values: [0-9]+ |
| limit | integer | no | Specifies the maximum number of tickets to be returned. Possible values: [0-9]+ |
| userId | integer | no | Specifies the user ID as assignee for a ticket for which user tickets should be returned. |
| createdBy | integer | no | Specifies the user ID who created the ticket for which user tickets should be returned. |
| ticketNo | string | no | The ticket Number for which data is to be returned. |
| dateFrom | string | no | The starting date from which to return tickets. If populated, dateTo and dateField are also required. |
| dateTo | string | no | The end date until which to return tickets. If populated, dateFrom and dateField are also required. |
| dateField | integer | no | The date field to be used with the data parameters. If populated, dateFrom and dateTo are also required. Possible values: firstSentTime, lastSentTime, firstOpenTime, firstReceivedTime, softDeadline, lastCloseTime, lastReceivedTime |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| rows | array of object | Array of ticket elements. |
| totalCount | integer | Number of ticket records returned. |
| messages | array | Message list returned by the API (typically empty). |
| errors | array | List of errors, if any (typically empty). |
Ticket object
| Name | Type | Comment |
|---|---|---|
| ticketId | integer | Ticket unique identifier. |
| ticketNo | string | Ticket number in formatted string form. |
| type | string or null | Ticket type if specified. |
| name | string | Entity (customer) name associated with the ticket. |
| entityId | integer | Entity (customer) identifier associated with the ticket. |
| contactId | integer | Unique identifier of the contact. |
| contact_name | string | Contact’s full name. |
| contact_phone | string | Contact phone number. Empty if not provided. |
| contact_email | string | Contact email address. |
| title | string | Ticket title. |
| description | string | Ticket description. Empty if not provided. |
| firstSentTime | string or null | Timestamp of the first outbound message sent related to this ticket. |
| lastSentTime | string or null | Timestamp of the last outbound message sent. |
| softDeadline | string | Deadline for the response based on SLA rules. |
| subStatus | string | Sub-status of the ticket (e.g., “Waiting for Agent”). |
| firstOpenTime | string or null | When the ticket was first opened. |
| agentName | string or null | Name of the assigned agent, if any. |
| firstReceivedTime | string or null | Timestamp of the first inbound message received. |
| firstCloseTime | string or null | Timestamp of the first time the ticket was closed. |
| lastCloseTime | string or null | Timestamp of the last closure action. |
| lastReceivedTime | string or null | Timestamp of the last inbound message received. |
| receivedEmailCount | integer or null | Number of received emails related to this ticket. |
| sentEmailCount | integer or null | Number of sent emails related to this ticket. |
| callCount | integer | Number of related voice call interactions. |
| chatCount | integer | Number of related chat interactions. |
| createdUserName | string | Name of the user who created the ticket. |
| mergedTickets | string or null | List or string reference of merged tickets, if any. |
| ticketType | string | Type/category of the ticket (empty string if not provided). |
Example
Response body
{
"response": {
"rows": [
{
"ticketId": 4,
"ticketNo": "1-20250319-905164",
"type": null,
"name": "Test1",
"entityId": 5,
"contactId": 5,
"contact_name": "Test 1",
"contact_phone": "",
"contact_email": "[email protected]",
"title": "Test 2",
"description": "",
"firstSentTime": "2025-03-19 09:34:58",
"lastSentTime": "2025-03-19 09:34:58",
"softDeadline": "2025-03-19 09:34:00",
"subStatus": "Waiting for Agent",
"firstOpenTime": "2025-03-19 09:34:45",
"agentName": null,
"firstReceivedTime": null,
"firstCloseTime": null,
"lastCloseTime": null,
"lastReceivedTime": null,
"receivedEmailCount": null,
"sentEmailCount": 1,
"callCount": 10,
"chatCount": 10,
"createdUserName": "John Smith",
"mergedTickets": null,
"ticketType": ""
},
{
"ticketId": 5,
"ticketNo": "1-20250324-422038",
"type": null,
"name": "Jim",
"entityId": 6,
"contactId": 6,
"contact_name": "Jim",
"contact_phone": "06305479935",
"contact_email": "[email protected]",
"title": "Jim test3",
"description": "",
"firstSentTime": null,
"lastSentTime": null,
"softDeadline": "2025-03-24 07:14:00",
"subStatus": "Waiting for Agent",
"firstOpenTime": "2025-03-24 07:14:26",
"agentName": null,
"firstReceivedTime": "2025-02-10 07:13:55",
"firstCloseTime": null,
"lastCloseTime": null,
"lastReceivedTime": "2025-02-10 07:13:55",
"receivedEmailCount": 1,
"sentEmailCount": null,
"callCount": 0,
"chatCount": 0,
"createdUserName": "John",
"mergedTickets": null,
"ticketType": ""
}
],
"totalCount": 2,
"messages": []
},
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.