List FAQs
curl --request GET \
--url https://api.example.com/api/v1/faqsimport requests
url = "https://api.example.com/api/v1/faqs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/faqs', 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://api.example.com/api/v1/faqs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/faqs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/faqs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/faqs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyFAQs
List FAQs
Public list of published FAQs shown on the mobile app FAQ screen.
GET
/
api
/
v1
/
faqs
List FAQs
curl --request GET \
--url https://api.example.com/api/v1/faqsimport requests
url = "https://api.example.com/api/v1/faqs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/faqs', 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://api.example.com/api/v1/faqs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/faqs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/faqs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/faqs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyOverview
Returns the published FAQ entries shown on the mobile app’s FAQ screen, ordered byorder ascending. FAQs are managed by admins via the admin FAQs CRUD and can be edited at any time without a redeploy.
Authentication
None. This endpoint is public so the FAQ content is readable before a user signs up.Response — 200 OK
{
"items": [
{
"id": "665f0a1b2c3d4e5f60718293",
"question": "How does Swappr work?",
"answer": "You create a profile, upload details and photos of your home and then browse other verified tenants looking to swap. If both sides are interested, you can connect and begin the official swap process.",
"order": 1
}
]
}
| Field | Type | Notes |
|---|---|---|
items[].id | string | 24-char Mongo ObjectId. |
items[].question | string | The question text. |
items[].answer | string | The answer text. |
items[].order | integer | Display order (ascending). |
Only published FAQs are returned. Drafts (
isPublished: false) are visible only via the admin endpoints.See also
curl
curl https://api.swappr.co.uk/api/v1/faqs