Ticket Activities
A ticket activity records each action taken on a ticket: customer communications, internal notes, status changes and follow-ups. Together they form the ticket’s full history. The API exposes them for reading a ticket’s audit trail.
Methods
Section titled “Methods”Retrieve Single Ticket Activity
Section titled “Retrieve Single Ticket Activity”/backend/api/v1/ticketActivities/ID - fetch the ticket activity with the specified ID.
List Ticket Activities
Section titled “List Ticket Activities”/backend/api/v1/ticketActivities/ - list all ticket activities.
/backend/api/v1/tickets/ID/ticketActivities/ - list the activities for the ticket with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include activities with a higher ID |
createdSince | datetime | No | Only include activities created since the given time |
updatedSince | datetime | No | Only include activities updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| ticketActivityType | Activity Type | Preset Value | The type of activity being performed on the ticket |
| activityUser | Ticket Updated By | Preset Value | The user who performed this ticket activity |
| containsPersonalData | Contains Personal Data | Preset Value | Whether this activity contains personal data that may be subject to data protection regulations |
| activityText | Content | Text | Main content of the activity that will be sent to customers or external parties |
| sendContentByEmail | Send by Email | Preset Value | Whether to send the activity content via email |
| commentText | Comment | Text | Internal comments about this activity that are not sent externally |
| updateText | Update Customer | Text | Update message to send to the customer about this activity |
| sendUpdateByEmail | Update Customer by Email | Preset Value | Whether to send the customer update via email |
| activityDepartments | Departments | Text | Departments that should be notified about this activity |
| activityUsers | Users | Text | Specific users that should be notified about this activity |
| activitySuppliers | Suppliers | Text | Suppliers that should be notified about this activity |
| standardTicketAttachments | Standard Attachments | Text | Standard attachments that are commonly sent with ticket activities |
| thisTicketAttachments | Attachment for This Ticket | Text | Attachments specific to this ticket |
| invoiceAttachments | Invoices | Text | Invoice documents to attach to this activity |
| activityDate | Activity Date | Date | The date when this activity occurred |
| responseReceivedDate | Response Received | Date | The date when a response was received for this activity |
| responseAcknowledgedDate | Response Acknowledged | Date | The date when the response was acknowledged |
| actionTakenDate | Action Taken | Date | The date when the required action was taken |
| actionRequiredDate | Action Required | Date | The date by which action is required for this activity |
| actionRequiredTime | Action Required | Text | The time by which action is required |
| followupDate | Follow-up Required | Date | The date when follow-up is required for this activity |
| followupTime | Follow-up Required | Text | The time when follow-up is required |
| id | Ticket Activity ID | Text | The unique identifier for this ticket activity |
| ticketID | Ticket | Text | The ID of the ticket this activity is for |
| parentActivity | Follow-up To | Text | The ID of the parent activity this is a follow-up to |