Categories
Manage FAQ categories
Manage FAQ categories
List categories
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Query Parameters
Include categories with zero questions
"true" | "false"Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/categories"{
"data": [
{
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"icon": "string",
"order": 0,
"parentId": "string",
"questionCount": 0
}
]
}Create a category
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/categories" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"data": {
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"icon": "string",
"order": 0,
"parentId": "string"
}
}Get category with questions
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Category slug
Query Parameters
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/categories/string"{
"data": {
"category": {
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"icon": "string",
"questionCount": 0
},
"questions": [
{
"id": "string",
"question": "string",
"answer": "string",
"slug": "string",
"tags": [
"string"
],
"views": 0,
"featured": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"meta": {
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}
}
}Update a category
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/categories/string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"icon": "string",
"order": 0,
"questionCount": 0
}
}Delete a category
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Query Parameters
Category slug to reassign questions to, or 'none'
Response Body
application/json
curl -X DELETE "https://app.thefaq.app/api/v1/string/categories/string"{
"data": {
"deleted": true,
"slug": "string"
}
}