Skip to main content
GET
/
api
/
public
/
faqs
List FAQs
curl --request GET \
  --url https://spaces.nexudus.com/api/public/faqs \
  --header 'Authorization: Basic <encoded-value>'

​
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

​
_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.

​
Response

Returns a FaqList object containing FAQ entries grouped by category.

​
Top-Level Fields

FieldTypeDescription
Categoriesstring[]Array of distinct FAQ group/category names
OpenAiEnabledbooleanWhether AI-powered FAQ search is enabled

​
FaqArticles Array

FieldTypeDescription
IdnumberUnique numeric identifier for the FAQ
UniqueIdstringGlobally unique identifier
TitlestringFAQ question / title
SummaryTextstringShort answer summary
FullTextstringFull answer body (HTML)
GroupNamestringCategory name the FAQ belongs to
DisplayOrdernumberSort order within the group
ActivebooleanWhether the FAQ is published
HasImagebooleanWhether the FAQ has a thumbnail image
HasLargeImagebooleanWhether the FAQ has a large image
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)

​
Examples

​
Fetch FAQs

GET /api/public/faqs

​
TypeScript Integration

import endpoints from '@/api/endpoints'

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