Get Support Ticket by Id
Get a single Support Ticket.
Securityapi-key
Responses
200
Returns a single support ticket.
400
Throws an error for an invalid ticket id.
401
Throws an error for an unauthorized request.
404
Throws an error for a support ticket that does not exist.
get/api/v2/support-tickets/{id}
Response samples
- 200
- 400
- 401
- 404
application/json
{- "id": "INC000001234567",
- "name": "Ticket Name Label",
- "description": "This is the description of the ticket",
- "priority": [
- "Low",
- "Medium",
- "High",
- "Critical"
], - "status": "Acknowledged",
- "ticketType": "Incident",
- "creationDate": "2023-01-01T01:02:03.000+0000",
- "notes": [
- {
- "id": "category",
- "text": "Console Connect",
- "@type": "faultsymptom"
}, - {
- "id": "item",
- "text": "Billing",
- "@type": "faultsymptom"
}, - {
- "id": "type",
- "text": "Cloud",
- "@type": "faultsymptom"
}, - {
- "id": "Email-Open Ticket",
- "text": "An example note for communication about the ticket",
- "worklogId": "WLG000012345678",
- "@type": "worklog"
}
], - "relatedParty": [
- {
- "name": "Contact Name",
- "phone": "+123456789",
- "email": "contact.name@emaildomain.com"
}
], - "relatedEntity": [
- {
- "name": "AAA111",
- "role": "customerId",
- "@type": "RelatedEntity",
- "@referredType": "Profile"
}
], - "channel": {
- "name": "Phone",
- "@type": "Customer"
}, - "@type": "troubleTicket"
}