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,
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A FaqArticle is a frequently asked question and answer published in the members portal, with optional audience restrictions for customers, plans, and teams; location-network visibility is controlled by the viewing location’s FAQ data-visibility setting. Active, customer-eligible articles are also semantically matched to answer questions through the AI chat, WhatsApp, and voice channels. The same matcher can automatically answer Help Desk messages and customer comments when OpenAI Help Desk automation is enabled; matched replies include a link to the source FAQ. FAQ content changes refresh the embeddings used for these AI answers.

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 location that owns this FAQ article; the viewing location’s FAQ data-visibility setting controls where it can be displayed across a location network..

string

Required question or heading shown for this FAQ article..

string

Optional short plain-text or HTML summary of the answer, used with the article content in FAQ search indexing..

string

Optional full answer displayed in the members portal; HTML content is supported and is included in FAQ search indexing..

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 the article is active and therefore eligible to appear in the members portal, subject to its audience restrictions..

string

Optional group or category name used to organize FAQ articles; portal lists are ordered by group first..

integer

Numeric position used to order articles within a group; create and update handlers normalize stored positions after changes..

boolean

Whether the article is marked to be shown on the members portal home page..

boolean

Whether the article is restricted to contacts, meaning customers without an active contract; this restriction is cumulative with all other audience restrictions..

boolean

Whether the article is restricted to members, meaning customers with an active contract; this restriction is cumulative with all other audience restrictions..

integer[]

List of plan IDs whose active members may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

integer[]

List of customer IDs who may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

integer[]

List of team IDs whose customers may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

string

Read-only denormalized names of the selected plans, maintained from Tariffs; use Tariffs to change the restriction..

string

Read-only denormalized names of the selected teams, maintained from Teams; use Teams to change the restriction..

string

Read-only denormalized names of the selected customers, maintained from Members; use Members to change the restriction..

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,
  "Tariffs": [],
  "Members": [],
  "Teams": [],
  "TariffNames": null,
  "TeamNames": null,
  "CoworkerFullNames": null,
  "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 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,
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "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