FaqArticles
Get one FaqArticle
Retrieve a single FaqArticle record by its Id.
GET
Get one FaqArticle
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
The Id of the FaqArticle record to retrieve.
Code Examples
Response
200
ID of the business linked to this record.
The title value for this faq article.
The summary text value for this faq article.
The full text value for this faq article.
Current file name of the image (read-only; upload via the corresponding URL field).
URL of a new file to upload as the image.
Set to true to remove the current image file.
Current file name of the large image (read-only; upload via the corresponding URL field).
URL of a new file to upload as the large image.
Set to true to remove the current large image file.
Whether this faq article is currently active.
The group name value for this faq article.
The display order value for this faq article.
Whether show in home page is enabled.
Whether only for contacts is enabled.
Whether only for members is enabled.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one FaqArticle