Search FaqArticles

GET

api

content

faqarticles

Search FaqArticles

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by 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

Filter by required question or heading shown for this FAQ article..

string

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

string

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

string

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

string

Filter by uRL of a new file to upload as the image.

boolean

Filter by set to true to remove the current image file.

string

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

string

Filter by uRL of a new file to upload as the large image.

boolean

Filter by set to true to remove the current large image file.

boolean

Filter by whether the article is active and therefore eligible to appear in the members portal, subject to its audience restrictions..

string

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

integer

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

boolean

Filter by whether the article is marked to be shown on the members portal home page..

boolean

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

boolean

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

string

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

string

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

string

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

Range Filters

integer

Filter by numeric position used to order articles within a group; create and update handlers normalize stored positions after changes. greater than or equal to this value.

integer

Filter by numeric position used to order articles within a group; create and update handlers normalize stored positions after changes. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/faqarticles?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/faqarticles?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Title',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/faqarticles',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Title

curl -X GET \
  "https://spaces.nexudus.com/api/content/faqarticles?FaqArticle_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/faqarticles?' + new URLSearchParams({
    FaqArticle_Title: 'example-value',
    orderBy: 'Title',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/faqarticles',
    params={
        'FaqArticle_Title': 'example-value',
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/faqarticles?from_FaqArticle_UpdatedOn=2025-01-01T00:00&to_FaqArticle_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/faqarticles?' + new URLSearchParams({
    from_FaqArticle_UpdatedOn: '2025-01-01T00:00',
    to_FaqArticle_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/faqarticles',
    params={
        'from_FaqArticle_UpdatedOn': '2025-01-01T00:00',
        'to_FaqArticle_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

FaqArticle[]

The list of FaqArticle records matching the query. See the Get one FaqArticle endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each FaqArticle. The following fields are not populated in the Records[] response: FullText, ShowInHomePage.To get all fields, fetch the full record using the Get one FaqArticle endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Title": "",
      "SummaryText": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "Active": false,
      "GroupName": null,
      "DisplayOrder": 0,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search FaqArticles

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Title

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200