List FAQs

Returns all published FAQ entries for the current location.

GET /api/public/faqs

List FAQs

cURL

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

import requests

url = "https://spaces.nexudus.com/api/public/faqs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/faqs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

GET /api/public/faqs

TypeScript Integration

import endpoints from '@/api/endpoints'

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