> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Help Desk Messages

> Returns the authenticated customer's help desk messages, optionally including closed tickets.

# 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

<ParamField query="showClosed" type="boolean" required>
  `true` — include closed/resolved tickets. `false` — return only open tickets.
</ParamField>

<ParamField query="_shape" type="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`.
</ParamField>

## Response

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

### Help Desk Message Fields

#### Identity

| Field      | Type     | Description                               |
| ---------- | -------- | ----------------------------------------- |
| `Id`       | `number` | Unique numeric identifier for the message |
| `UniqueId` | `string` | Globally unique identifier                |

#### Core

| Field         | Type      | Description                             |
| ------------- | --------- | --------------------------------------- |
| `Subject`     | `string`  | Ticket subject line                     |
| `MessageText` | `string`  | Ticket body text                        |
| `Closed`      | `boolean` | Whether the ticket is closed / resolved |
| `HasImage`    | `boolean` | Whether an image attachment exists      |

#### Nested Objects

| Field        | Type       | Description                                             |
| ------------ | ---------- | ------------------------------------------------------- |
| `Department` | `object`   | Help desk department (`Id`, `Name`, `Description`)      |
| `Coworker`   | `object`   | Customer who opened the ticket (`Id`, `FullName`, etc.) |
| `Comments`   | `object[]` | Array of reply comments on this ticket                  |

#### Timestamps (from base)

| Field          | Type             | Description                             |
| -------------- | ---------------- | --------------------------------------- |
| `CreatedOn`    | `string`         | Date created (business-local time)      |
| `UpdatedOn`    | `string \| null` | Date last updated (business-local time) |
| `CreatedOnUtc` | `string`         | Date created (UTC)                      |
| `UpdatedOnUtc` | `string \| null` | Date last updated (UTC)                 |

## Examples

### Fetch open tickets

```http theme={null}
GET /api/public/helpdesk/messages?showClosed=false
Authorization: Bearer {token}
```

### Fetch all tickets including closed

```http theme={null}
GET /api/public/helpdesk/messages?showClosed=true
Authorization: Bearer {token}
```

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const { resource: messages } = useTypedData(httpClient, endpoints.helpDesk.list(false))
```
