Developer API: How can I use the API?

How can I use the API?

Last updated over 3 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:

Our public URL is: https://slimfaq.com/faq
To access the API, we'll just add `.json` and get https://slimfaq.com/faq.json
The response will look something like this:

{
  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"
        },
        …
      ]
    },
    …
  ]
}

For a category, you can just take the public category's URL and add `.json`
e.g. https://slimfaq.com/faq/24-getting-started becomes https://slimfaq.com/faq/24-getting-started.json
Same goes with a question - just take the public question's URL and add `.json`
e.g. https://slimfaq.com/faq/24-getting-started/82-what-is-slimfaq turns into https://slimfaq.com/faq/24-getting-started/82-what-is-slimfaq.json
For search:
https://slimfaq.com/faq/search.json?term=custom+domains

We've also set `Access-Control-Allow-Origin` to `*` so you can access this API through javascript on your site.