Get a ticket with messages

GET

/api/v1/business/website/tickets/{ticket_id}/

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

Path Parameters

ticket_id*

Type

string

Required

Format

"uuid"

Responses

Ticket detail with the conversation.

Content-Type

application/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": [

  

  

]

  

}

}

GET

/api/v1/business/website/tickets/{ticket_id}/

Playground

Server

Authorization

apiKey

shopperToken

Variables

Key

Value

ticket_id*

Samples

Powered by VitePress OpenAPI