List FAQ categories
curl --request GET \
--url https://{host}/v1/faq-categories \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/v1/faq-categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/faq-categories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/v1/faq-categories"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"type": "faq-categories",
"id": "4",
"attributes": {
"name": "Buying",
"slug": "buying",
"description": "Paying, shipping, and what happens after.",
"locale": "en",
"order": 1
},
"relationships": {
"articles": {
"data": [
{
"type": "faq-articles",
"id": "91"
}
]
}
}
}
],
"included": [
{
"type": "faq-articles",
"id": "91",
"attributes": {
"name": "How do I pay?",
"content": "<p>By card, at the checkout.</p>",
"slug": "how-do-i-pay",
"locale": "en",
"order": 1
}
}
]
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Content (FAQ)
List FAQ categories
Scope: content:read
The help centre’s headings, in the order they are shown. ?include=articles
brings the answers with them, which is the whole screen in one call — which is
also why this list is not paged.
An answer still being written is in neither.
GET
/
v1
/
faq-categories
List FAQ categories
curl --request GET \
--url https://{host}/v1/faq-categories \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/v1/faq-categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/faq-categories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/v1/faq-categories"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"type": "faq-categories",
"id": "4",
"attributes": {
"name": "Buying",
"slug": "buying",
"description": "Paying, shipping, and what happens after.",
"locale": "en",
"order": 1
},
"relationships": {
"articles": {
"data": [
{
"type": "faq-articles",
"id": "91"
}
]
}
}
}
],
"included": [
{
"type": "faq-articles",
"id": "91",
"attributes": {
"name": "How do I pay?",
"content": "<p>By card, at the checkout.</p>",
"slug": "how-do-i-pay",
"locale": "en",
"order": 1
}
}
]
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Authorizations
oauth2bearerAuth
Headers
The language to answer in: specificationLabels, translatedDescription, facet
and label names, the content pages, and every other translated word in the
answer. Read on every request, whatever the endpoint. One we do not have falls
back to English rather than failing.
Available options:
en, nl, de, es, fr, it, pt, fi, pl Query Parameters
Response
The headings.