TheFAQApp - Frequently Asked Questions

Question 1

How do I authenticate API requests?

TheFAQApp · Accepted Answer

All API requests require a Bearer token. Create API keys in your dashboard under Settings → API Keys. Include the key in the Authorization header: curl https://www.thefaq.app/api/v1/your-org/questions \ -H "Authorization: Bearer faq_your-api-key" API keys have scopes (read, write, admin) depending o...

Question 2

What plans are available?

TheFAQApp · Accepted Answer

TheFAQApp offers four plans: Free — 1 API key, read-only access, 1,000 requests/month. Perfect for trying it out. Starter ($19/mo) — 5 API keys, read + write access, 10,000 requests/month. Great for small teams. Pro ($49/mo) — Unlimited API keys, full access, 100,000 requests/month, webhooks, custom...

Question 3

How do I embed the FAQ widget?

TheFAQApp · Accepted Answer

Add a single script tag to your page: The widget includes search, category filtering, and accordion-style Q&A — all powered by the same API. You can customize colors, fonts, and layout to match your brand.

Question 4

How do I set up a custom domain?

TheFAQApp · Accepted Answer

Custom domains are available on the Pro plan and above. To set one up: Go to Settings → Domains in your dashboard Enter your domain (e.g., faq.yourcompany.com) Add the CNAME record we provide to your DNS settings Wait for DNS propagation and SSL provisioning (usually 5-15 minutes) Once verified, you...

Question 5

How do I manage team members?

TheFAQApp · Accepted Answer

Go to Settings → Team in your dashboard. You can invite team members by email and assign roles: Owner — Full access, billing management, can delete the organization Admin — Full content access, can manage team members and settings Member — Can create and edit content Viewer — Read-only access to the...

Question 6

How do API key scopes work?

TheFAQApp · Accepted Answer

API keys have three scope levels: read — List and retrieve questions, categories, and search. Available on all plans. write — Create, update, and delete content. Available on Starter and above. admin — Manage organization settings, API keys, and webhooks. Available on Pro and above. Each API key is ...

Question 7

What is TheFAQApp?

TheFAQApp · Accepted Answer

TheFAQApp is an API-first FAQ platform for modern products. It gives you a REST API, TypeScript SDKs, and embeddable widgets to manage, search, and serve FAQ content anywhere — your app, your docs, your chatbot. Every organization gets a hosted FAQ portal with search, categories, and SEO optimizatio...

Question 8

Can I change plans at any time?

TheFAQApp · Accepted Answer

Yes, you can upgrade or downgrade your plan at any time from your dashboard under Settings → Billing. When upgrading, the new plan takes effect immediately and you'll be charged a prorated amount. When downgrading, the change takes effect at the end of your current billing cycle.

Question 9

Can I customize the widget appearance?

TheFAQApp · Accepted Answer

Yes. The widget supports several customization options: Theme — Light or dark mode Colors — Primary accent color, background, text colors Layout — Accordion, list, or card view Categories — Show all or filter to specific categories Search — Enable or disable the search bar Configure these in your da...

Question 10

What SDKs are available?

TheFAQApp · Accepted Answer

We offer two first-party TypeScript packages: @faqapp/core — Type-safe API client with full CRUD operations, pagination, error handling, and retry logic. Works in any JavaScript/TypeScript environment. @faqapp/nextjs — React hooks and SSR/SSG helpers built on top of @faqapp/core. Includes useFaq(), ...

How can we help?

Browse by topic

Getting Started

Pricing & Billing

API & SDKs

Widgets & Embeds

Custom Domains

Account & Security

Popular articles

How do I authenticate API requests?

What plans are available?

How do I embed the FAQ widget?

How do I set up a custom domain?

How do I manage team members?

All articles

Can't find what you need?

Stay updated