Get one FaqArticle

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>'

import requests

url = "https://spaces.nexudus.com/api/content/faqarticles/{id}"

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/content/faqarticles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/faqarticles/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/faqarticles/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

The title value for this faq article.

string

The summary text value for this faq article.

string

The full text value for this faq article.

string

Current file name of the image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

string

Current file name of the large image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the large image.

boolean

Set to true to remove the current large image file.

boolean

Whether this faq article is currently active.

string

The group name value for this faq article.

integer

The display order value for this faq article.

boolean

Whether show in home page is enabled.

boolean

Whether only for contacts is enabled.

boolean

Whether only for members is enabled.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple FaqArticlesRetrieve multiple FaqArticle records by their Ids in a single request.

Get one FaqArticle

curl --request GET \
  --url https://spaces.nexudus.com/api/content/faqarticles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/faqarticles/{id}"

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/content/faqarticles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200