FAQ

This page covers the FAQ activities that deals with fetching various Help center categories & specific categories. On this page, we’ll dive into the different FAQ endpoints.

GET/api/v2/content/faq

Get all FAQs

This endpoint helps us to retreive all the FAQs.

Developers - API Operations:

Operation	Endpoint	Response
FAQ	`/api/v2/content/faq`	Get all FAQs

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
categoryId
Type
string
Description
Category Id
Name
categoryName
Type
string
Description
Name of the category
Name
id
Type
string
Description
Unique identifier for the group.
Name
question
Type
string
Description
Question asked in the FAQ section
Name
answer
Type
string
Description
Answer provided in the FAQ section

Request

POST

/api/v2/content/faq

curl --location -g --request GET '/api/v2/content/faq'

Response

{
"statusCode": 400,
"status": "exercitation veniam",
"errors": [
"anim exercitation",
],
"success": false,
"message": "sit in",
"messageCode": "veniam nulla voluptate sunt",
"result": [
    {
        "categoryId": "et aliqua id eu",
        "categoryName": "cillum in laborum laboris minim",
        "id": 12622055,
        "question": "laboris pariatur et quis",
        "answer": "qui"
    }
]
}

GET/api/v2/content/faq/:categoryId

Gets Faq for specific category

This endpoint helps us to retreive all the FAQs for a specific category.

Developers - API Operations:

Operation	Endpoint	Response
FAQ for a specific category	`/api/v2/content/faq/:categoryId`	Get FAQs for a specific category

Required attributes

Name
categoryId
Type
string
Description
Id of the Category

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
categoryId
Type
string
Description
Category Id
Name
categoryName
Type
string
Description
Name of the category
Name
id
Type
string
Description
Unique identifier for the group.
Name
question
Type
string
Description
Question asked in the FAQ section
Name
answer
Type
string
Description
Answer provided in the FAQ section

Request

GET

/api/v2/content/faq/:categoryId`

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/faq/-12523966' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
 "statusCode": 416,
 "status": "est irure exercitation proident",
 "errors": [
  "veniam qui"
 ],
 "success": true,
 "message": "et officia dolor labore",
 "messageCode": "ut ut officia",
 "result": [
  {
   "categoryId": "anim Duis ad reprehenderit",
   "categoryName": "Ut ex consectetur",
   "id": -36632509,
   "question": "irure Duis",
   "answer": "i"
  }
 ]
}

GET/api/v2/content/faq/help-center

Get helpcenter categories and faq items

This endpoint enables us to retrieve helpcenter categories & FAQ items

Developers - API Operations:

Operation	Endpoint	Response
Helpcenter categories & FAQ items	`/api/v2/content/faq/help-center`	Get helpcenter categories & FAQ items

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
object
Description
Result of the response
Name
categoryId
Type
string
Description
Category Id
Name
categoryName
Type
string
Description
Name of the category
Name
childItems
Type
array
Description
Array containing a list of values
Name
question
Type
string
Description
Question asked in the FAQ section
Name
answer
Type
string
Description
Answer provided in the FAQ section

Request

GET

/api/v2/content/faq/help-center

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/faq/help-center' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
 "statusCode": 406,
 "status": "Excepteur et",
 "errors": [
  "fugiat sint"
 ],
 "success": true,
 "message": "proident culpa mol",
 "messageCode": "eu Lorem veniam culpa",
 "result": [
  {
   "categoryId": "ut",
   "categoryName": "in et enim",
   "childItems": [
    {
     "value": "<Error: Too many levels of nesting to fake this schema>"
    }
   ]
  }
 ]
}

GET/api/v2/content/faq/categories

Get FAQ Categories

This endpoint enables us to retrieve FAQ categories.

Developers - API Operations:

Operation	Endpoint	Response
FAQ categories	`/api/v2/content/faq/categories`	Get FAQ categories

Response attributes

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response

Request

GET

/api/v2/content/faq/categories

curl --location --request GET 'https://api20.bettercommerce.io/api/v2/content/faq/categories' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
 "statusCode": 501,
 "status": "ea mollit",
 "errors": [
  "ipsum magna",
 ],
 "success": false,
 "message": "ipsum ut",
 "messageCode": "consequat tempor"
}