API Reference
F A Qs
Public FAQ page data
Public FAQ page data
Get public FAQ page data
Authorization
BearerAuth AuthorizationBearer <token>
API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
organizationSlug*string
Query Parameters
format?string
Response format
Value in
"json" | "text" | "markdown"published?string
Filter by publish status (default: true)
Value in
"true" | "false" | "all"category?string
Filter by category slug
limit?|
Max results (default 50, max 200)
Range
value <= 200include_metadata?string
Include seoTitle, tags, timestamps
Value in
"true" | "false"Response Body
curl -X GET "https://app.thefaq.app/api/v1/string/faqs"{
"data": {
"organization": {
"name": "string",
"slug": "string"
},
"faqs": [
{
"question": "string",
"answer": "string",
"slug": "string",
"category": "string",
"seoTitle": "string",
"tags": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"meta": {
"total": 0,
"format": "string",
"generatedAt": "2019-08-24T14:15:22Z"
}
}
}Empty