Tickets API

Retrieve paginated list of support tickets with filters

Support

Tickets API

Retrieve a paginated list of support tickets with optional filtering by category and status. Manage and monitor support requests efficiently.

Paginated List

Browse all tickets.

Filters

Category and status.

Counts

Total elements.


Endpoint Overview

QUERY/graphql

Retrieve a paginated list of tickets with optional category and status filters.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

pageInt

Page number for pagination (0-indexed).

sizeInt

Number of tickets per page.

categoryTicketCategory

Filter by ticket category (e.g., Technical, Billing).

statusTicketStatus

Filter by ticket status (e.g., Open, Closed, Pending).


GraphQL Query

query tickets($page: Int, $size: Int, $category: TicketCategory, $status: TicketStatus) {
  tickets(page: $page, size: $size, category: $category, status: $status) {
    totalElements
    size
    number
    content {
      id
      subject
      category
      status
      createdAt
    }
  }
}

Variables:

{
  "page": 0,
  "size": 20,
  "category": "Technical",
  "status": "Open"
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query tickets($page: Int, $size: Int, $status: TicketStatus) { tickets(page: $page, size: $size, status: $status) { totalElements size number } }",
    "variables": { "page": 0, "size": 20, "status": "Open" }
  }'

Response

200Tickets Retrieved Successfully
{
  "data": {
    "tickets": {
      "totalElements": 100,
      "size": 20,
      "number": 0,
      "content": [
        {
          "id": 1,
          "subject": "Issue with login",
          "category": "Technical",
          "status": "Open",
          "createdAt": "2024-08-11T14:32:00Z"
        }
      ]
    }
  }
}

Response Fields

totalElementsInt!

Total number of tickets matching the query.

sizeInt!

Number of tickets per page.

numberInt!

Current page number (0-indexed).

content[Ticket!]!

Array of ticket objects for the current page.



Admin Access Required

This endpoint requires admin privileges to access all tickets across the system.

Get User's Tickets

Retrieve tickets for the currently authenticated user.

User Tickets