Skip to main content
GET
/
api
/
content
/
faqarticles
/
{id}
Get one FaqArticle
curl --request GET \
  --url https://spaces.nexudus.com/api/content/faqarticles/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Title": "<string>",
  "SummaryText": "<string>",
  "FullText": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "LargeImageFileName": "<string>",
  "NewLargeImageUrl": "<string>",
  "ClearLargeImageFile": true,
  "Active": true,
  "GroupName": "<string>",
  "DisplayOrder": 123,
  "ShowInHomePage": true,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A FaqArticle represents a frequently asked question and its answer, displayed on the members portal to help customers find information without contacting support.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the FaqArticle-Read role.

Path Parameters

id
integer
required
The Id of the FaqArticle record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/faqarticles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId
integer
ID of the business linked to this record.
Title
string
The title value for this faq article.
SummaryText
string
The summary text value for this faq article.
FullText
string
The full text value for this faq article.
ImageFileName
string
Current file name of the image (read-only; upload via the corresponding URL field).
NewImageUrl
string
URL of a new file to upload as the image.
ClearImageFile
boolean
Set to true to remove the current image file.
LargeImageFileName
string
Current file name of the large image (read-only; upload via the corresponding URL field).
NewLargeImageUrl
string
URL of a new file to upload as the large image.
ClearLargeImageFile
boolean
Set to true to remove the current large image file.
Active
boolean
Whether this faq article is currently active.
GroupName
string
The group name value for this faq article.
DisplayOrder
integer
The display order value for this faq article.
ShowInHomePage
boolean
Whether show in home page is enabled.
OnlyForContacts
boolean
Whether only for contacts is enabled.
OnlyForMembers
boolean
Whether only for members is enabled.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "Title": "",
  "SummaryText": null,
  "FullText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "Active": false,
  "GroupName": null,
  "DisplayOrder": 0,
  "ShowInHomePage": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "FaqArticle Example",
  "LocalizationDetails": null,
  "CustomFields": null
}