Tickets

Support tickets

Create support ticket

post
/tickets/create

Create a new support ticket

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Body
subjectstring · min: 5 · max: 500RequiredExample: Issue with order
messagestring · min: 10RequiredExample: I have an issue with my recent order...
categorystring · enumOptionalDefault: generalPossible values:
prioritystring · enumOptionalDefault: mediumPossible values:
Responses
post
/tickets/create
POST /api/v3/tickets/create HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "subject": "Issue with order",
  "message": "I have an issue with my recent order...",
  "category": "general",
  "priority": "medium"
}
201

Ticket created successfully

{
  "success": true,
  "data": {
    "ticket": {
      "id": 1,
      "ticket_number": "TKT-1701234567-5678",
      "subject": "Issue with order",
      "category": "order",
      "priority": "medium",
      "status": "open",
      "created_at": "2023-12-01 10:30:00"
    }
  }
}

Get user tickets

get
/tickets

Retrieve list of user's support tickets

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Query parameters
statusstring · enumOptionalPossible values:
pageintegerOptionalDefault: 1
limitintegerOptionalDefault: 20
Responses
200

Tickets retrieved successfully

application/json
get
/tickets
GET /api/v3/tickets HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Tickets retrieved successfully

{
  "success": true,
  "data": {
    "tickets": [
      {
        "id": 1,
        "ticket_number": "TKT-1701234567-5678",
        "subject": "Issue with order",
        "category": "order",
        "priority": "medium",
        "status": "open",
        "created_at": "2023-12-01 10:30:00"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 100,
      "total_pages": 5
    }
  }
}

Get ticket details

get
/tickets/{ticketNumber}

Retrieve detailed information about a ticket

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Path parameters
ticketNumberstringRequiredExample: TKT-1701234567-5678
Responses
200

Ticket details retrieved successfully

No content
get
/tickets/{ticketNumber}
GET /api/v3/tickets/{ticketNumber} HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Ticket details retrieved successfully

No content

Close ticket

put
/tickets/{ticketNumber}/close

Close a support ticket

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Path parameters
ticketNumberstringRequiredExample: TKT-1701234567-5678
Responses
200

Ticket closed successfully

No content
put
/tickets/{ticketNumber}/close
PUT /api/v3/tickets/{ticketNumber}/close HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Ticket closed successfully

No content
PreviousReferralsNextModels

Last updated