Ticket API
Retrieve a specific support ticket by its ID
Support
Ticket API
Retrieve detailed information about a specific support ticket. Access subject, content, category, status, and creation time.
Ticket Details
Complete information.
Category
Issue classification.
Status
Current state.
Endpoint Overview
QUERY
/graphqlRetrieve a specific support ticket by its unique ID.
Authentication:Bearer Token
Required scopes:useradmin
Request Parameters
idInt!RequiredThe unique identifier of the ticket to retrieve.
GraphQL Query
query ticket($id: Int!) {
ticket(id: $id) {
id
subject
text
category
status
createdAt
}
}Variables:
{
"id": 123
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query ticket($id: Int!) { ticket(id: $id) { id subject text category status createdAt } }",
"variables": { "id": 123 }
}'Response
200Ticket Retrieved Successfully
{
"data": {
"ticket": {
"id": 123,
"subject": "Issue with Login",
"text": "User is unable to log in with their credentials.",
"category": "Login Issue",
"status": "Open",
"createdAt": "2024-08-11T10:00:00Z"
}
}
}404Ticket Not Found
{
"errors": [
{
"message": "Ticket not found",
"path": ["ticket"],
"extensions": {
"code": "NOT_FOUND"
}
}
],
"data": null
}Response Fields
idInt!Unique identifier for the ticket.
subjectString!Brief subject or title of the ticket.
textString!Detailed description or content of the ticket.
categoryString!Category or type of the issue (e.g., Technical, Billing).
statusString!Current status of the ticket (e.g., Open, Closed, Pending).
createdAtDateTime!Timestamp when the ticket was created.
Related Endpoints
View All Tickets
Browse and filter all support tickets.