Skip to content

List support tickets

GET
/api/v1/business/website/tickets/

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Parameters

Query Parameters

status
Type
string
Valid values
"OPEN""IN_PROGRESS""WAITING_FOR_CUSTOMER""RESOLVED""CLOSED"

Responses

The shopper's tickets.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"ticket_number": "TKT-0001",
  
  
  
"subject": "string",
  
  
  
"description": "string",
  
  
  
"category": "string",
  
  
  
"priority": "string",
  
  
  
"status": "string",
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"last_activity_at": "string",
  
  
  
"messages_count": 0,
  
  
  
"last_message": null
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

© Periscale