API Keys — Create, List & Revoke Keys
Manage API keys for your TheFAQApp organization. Create, list, rotate, and revoke keys with read, write, and admin scoped permissions.
Manage API keys
List API keys
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/api-keys"{
"data": [
{
"id": "string",
"name": "string",
"scopes": [
"read"
],
"lastUsedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
]
}Create an API key
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/api-keys" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "scopes": [ "read" ] }'{
"data": {
"id": "string",
"name": "string",
"scopes": [
"read"
],
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"key": "string"
}
}Revoke an API key
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
API key ID
Response Body
application/json
curl -X DELETE "https://app.thefaq.app/api/v1/string/api-keys/string"{
"data": {
"id": "string",
"revoked": true
}
}Organization API — Account & Settings
Retrieve organization details, settings, and plan information via the TheFAQApp API. Read-only access to account config and limits.
Translations API — Multilingual FAQ Content
Manage translations for FAQ questions via the TheFAQApp API. Create and retrieve localized content for multilingual support.