Questions API — Create & Manage FAQ Entries
Manage FAQ questions via the TheFAQApp REST API. Full CRUD support for creating, updating, publishing, and deleting entries.
Manage FAQ questions
List questions
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Query Parameters
Filter by category slug
Full-text search query
"published" | "draft""true" | "false"Comma-separated tag values
"created" | "updated" | "views" | "alphabetical" | "order" | "helpful""asc" | "desc"Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/questions"{
"data": [
{
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"published": true,
"featured": true,
"status": "published",
"tags": [
"string"
],
"views": 0,
"seoTitle": "string",
"seoDescription": "string",
"category": {
"id": "string",
"name": "string",
"slug": "string"
},
"feedbackCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"meta": {
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}
}
}Create a question
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/questions" \ -H "Content-Type: application/json" \ -d '{ "question": "string", "answer": "string" }'{
"data": {
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"published": true,
"featured": true,
"tags": [
"string"
],
"category": {
"id": "string",
"name": "string",
"slug": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
}Get question by slug
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Question slug
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/questions/how-to-get-started"{
"data": {
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"published": true,
"featured": true,
"status": "published",
"tags": [
"string"
],
"views": 0,
"seoTitle": "string",
"seoDescription": "string",
"category": {
"id": "string",
"name": "string",
"slug": "string"
},
"stats": {
"totalFeedback": 0,
"helpfulCount": 0,
"notHelpfulCount": 0,
"helpfulPercentage": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}Update a question
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://app.thefaq.app/api/v1/string/questions/string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"published": true,
"featured": true,
"tags": [
"string"
],
"category": {
"id": "string",
"name": "string",
"slug": "string"
},
"updatedAt": "2019-08-24T14:15:22Z"
}
}Delete a question
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X DELETE "https://app.thefaq.app/api/v1/string/questions/string"{
"data": {
"deleted": true,
"slug": "string"
}
}Bulk create or update questions
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/questions/bulk" \ -H "Content-Type: application/json" \ -d '{ "questions": [ { "question": "string", "answer": "string" } ] }'{
"data": {
"created": 0,
"updated": 0,
"questions": [
{
"id": "string",
"slug": "string",
"question": "string"
}
]
}
}Export questions
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Query Parameters
value <= 1000"published" | "draft"Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/questions/export"{
"data": [
{
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"published": true,
"status": "published",
"featured": true,
"tags": [
"string"
],
"views": 0,
"upvotes": 0,
"downvotes": 0,
"seoTitle": "string",
"seoDescription": "string",
"category": {
"id": "string",
"name": "string",
"slug": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"meta": {
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}
}
}Get feedback stats
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/questions/string/feedback"{
"data": {
"totalFeedback": 0,
"helpfulCount": 0,
"notHelpfulCount": 0,
"helpfulPercentage": 0
}
}Submit feedback
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/questions/string/feedback" \ -H "Content-Type: application/json" \ -d '{ "helpful": true }'{
"data": {
"id": "string",
"helpful": true
}
}