How can I use the API?

Last updated over 2 years ago

The API is kept very simple - to get a JSON representation of your FAQ, just add `.json` to your public URL.

We'll take our official FAQ as an example:

  1. {
      name: "FAQ",
      url: "https://slimfaq.com/faq",
      categories: [
        {
          id: 24,
          name: "Getting Started 🚀",
          url: "https://slimfaq.com/faq/24-getting-started",
          questions: [
            {
              id: 82,
              name: "What is SlimFAQ?",
              url: "https://slimfaq.com/faq/24-getting-started/82-what-is-slimfaq"
            },
            …
          ]
        },
        …
      ]
    }
We've also set `Access-Control-Allow-Origin` to `*` so you can access this API through javascript on your site.