> ## 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 FAQs

> Returns all published FAQ entries for the current location.

# List FAQs

Returns the complete list of published FAQ entries for the current location, organised by group. Used to render the FAQ page in the portal.

## Authentication

No authentication required.

## Query Parameters

<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.
</ParamField>

## Response

Returns a `FaqList` object containing FAQ entries grouped by category.

### Top-Level Fields

| Field           | Type       | Description                                |
| --------------- | ---------- | ------------------------------------------ |
| `Categories`    | `string[]` | Array of distinct FAQ group/category names |
| `OpenAiEnabled` | `boolean`  | Whether AI-powered FAQ search is enabled   |

### FaqArticles Array

| Field           | Type             | Description                             |
| --------------- | ---------------- | --------------------------------------- |
| `Id`            | `number`         | Unique numeric identifier for the FAQ   |
| `UniqueId`      | `string`         | Globally unique identifier              |
| `Title`         | `string`         | FAQ question / title                    |
| `SummaryText`   | `string`         | Short answer summary                    |
| `FullText`      | `string`         | Full answer body (HTML)                 |
| `GroupName`     | `string`         | Category name the FAQ belongs to        |
| `DisplayOrder`  | `number`         | Sort order within the group             |
| `Active`        | `boolean`        | Whether the FAQ is published            |
| `HasImage`      | `boolean`        | Whether the FAQ has a thumbnail image   |
| `HasLargeImage` | `boolean`        | Whether the FAQ has a large image       |
| `CreatedOn`     | `string`         | Date created (business-local time)      |
| `UpdatedOn`     | `string \| null` | Date last updated (business-local time) |

## Examples

### Fetch FAQs

```http theme={null}
GET /api/public/faqs
```

## TypeScript Integration

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

const { resource: faqs } = useTypedData(httpClient, endpoints.faqs.list())
```