Skip to main content
GET
List Help Desk Messages

List Help Desk Messages

Returns a list of help desk messages (support tickets) belonging to the authenticated customer. By default returns only open tickets; set showClosed=true to include resolved tickets.

Authentication

Requires a valid customer bearer token.

Query Parameters

showClosed
boolean
required
true — include closed/resolved tickets. false — return only open tickets.
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Records.Subject,Records.Closed,Records.CreatedOn.

Response

Returns a HelpDeskMessages object containing an array of support ticket records.

Help Desk Message Fields

Identity

Core

Nested Objects

Timestamps (from base)

Examples

Fetch open tickets

Fetch all tickets including closed

TypeScript Integration