Tickets
A ticket tracks a customer request from start to finish, holding its type, priority, status and owner. The API lets you create, retrieve, update and delete tickets. See Ticket Management for the workflow and Ticket Configuration for the lists behind these fields.
Methods
Section titled “Methods”Retrieve Single Ticket
Section titled “Retrieve Single Ticket”/backend/api/v1/tickets/ID - fetch the ticket with the specified ID.
List Tickets
Section titled “List Tickets”/backend/api/v1/tickets/ - list all tickets.
/backend/api/v1/customers/ID/tickets/ - list tickets for the customer with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include tickets with a higher ID |
createdSince | datetime | No | Only include tickets created since the given time |
updatedSince | datetime | No | Only include tickets updated since the given time |
/backend/api/v1/tickets/ - create a new ticket. The newly-added ticket will be returned.
/backend/api/v1/tickets/ID - update the ticket with the specified ID. The modified ticket will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/tickets/ID - delete the ticket with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| customerID | Customer | Number | The ID of the customer this ticket is for |
| ticketType | Ticket Type | Preset Value | The type of ticket (e.g., sales, billing) |
| status | Ticket Status | Preset Value | Current status of the ticket (e.g., open, assigned, resolved, closed) |
| ticketPriority | Ticket Priority | Preset Value | The priority level of this ticket |
| customerEmail | Customer's Email Address | Text | Email address of the customer for this ticket |
| subject | Subject | Text | Brief description or title of the ticket |
| ticketContent | Content | Text | Most recent content or description from ticket activities |
| owner | Owned By | Preset Value | User who owns this ticket and is responsible for its resolution |
| users | Users | Text | Individual users assigned to work on this ticket |
| departments | Departments | Text | Departments assigned to work on this ticket |
| ticketSuppliers | Suppliers | Text | External suppliers involved in resolving this ticket |
| createdDate | Date | Date | Date when this ticket was created |
| ticketFollowupDate | Followup Required | Date | Date when followup action is required for this ticket |
| ticketActionRequiredDate | Action Required | Date | Date when specific action is required to be taken on this ticket |
| id | Ticket ID | Text | The unique identifier for this ticket |