{
"version": "https://jsonfeed.org/version/1",
"title": "helpkb - Open-source and easy to use knowledge base/faq",
"home_page_url": "https://helpkb.markmoffat.com",
"feed_url": "https://helpkb.markmoffat.com/json",
"description": "A superfast and easy to use knowledge base/faq to help your customers get the info they need, when they need it most.",
"items": [
{
"id": "https://helpkb.markmoffat.com/documentation/users/",
"content_html": "<h3 id=\"gets-a-list-of-users\">Gets a list of users</h3>\n<p>Retrieves a list of users</p>\n<p><strong>URL</strong> : <code>/api/users</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">[\n {\n id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n email: "[email protected]",\n name: "Jim Smith",\n enabled: true,\n admin: true,\n owner: true,\n createdAt: 2022-06-12T06:50:00.021Z,\n updatedAt: 2022-06-12T06:50:00.021Z\n }\n]\n</code></pre>\n<h3 id=\"gets-a-single-user\">Gets a single user</h3>\n<p>Search an article using a keyword</p>\n<p><strong>URL</strong> : <code>/api/user/:id</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: Single user</p>\n<h4 id=\"success-response-1\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n email: "[email protected]",\n name: "Jim Smith",\n enabled: true,\n admin: true,\n owner: true,\n createdAt: 2022-06-12T06:50:00.021Z,\n updatedAt: 2022-06-12T06:50:00.021Z\n}\n</code></pre>\n<h3 id=\"updates-a-single-user\">Updates a single user</h3>\n<p>Updates a given user</p>\n<p><strong>URL</strong> : <code>/api/user/save</code></p>\n<p><strong>Method</strong> : <code>PUT</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: Single user</p>\n<h4 id=\"success-response-2\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example request:</p>\n<pre><code class=\"language-json\">{\n id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n email: "[email protected]",\n name: "Jim Smith",\n enabled: true,\n admin: true\n}\n</code></pre>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n email: "[email protected]",\n name: "Jim Smith",\n enabled: true,\n admin: true,\n owner: true,\n createdAt: 2022-06-12T06:50:00.021Z,\n updatedAt: 2022-06-12T06:50:00.021Z\n}\n</code></pre>\n<h3 id=\"insert-a-new-user\">Insert a new user</h3>\n<p>Inserts a new user</p>\n<p><strong>URL</strong> : <code>/api/user/insert</code></p>\n<p><strong>Method</strong> : <code>PUT</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-3\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example request:</p>\n<pre><code class=\"language-json\">{\n email: "[email protected]",\n name: "Jim Smith"\n}\n</code></pre>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n email: "[email protected]",\n name: "Jim Smith",\n enabled: true,\n admin: true,\n owner: true,\n createdAt: 2022-06-12T06:50:00.021Z,\n updatedAt: 2022-06-12T06:50:00.021Z\n}\n</code></pre>\n<h3 id=\"deletes-existing-article\">Deletes existing article</h3>\n<p>Deletes an existing article content</p>\n<p><strong>URL</strong> : <code>/api/user/delete/:id</code></p>\n<p><strong>Method</strong> : <code>DELETE</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-4\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n <span class=\"hljs-attr\">"success"</span>\n}\n</code></pre>\n",
"url": "https://helpkb.markmoffat.com/documentation/users/",
"title": "Users",
"summary": "Documentation - The users API enables you to manage anything from selecting to deleting and updating users | helpkb",
"date_modified": "2022-06-16T01:56:00.000Z"
},
{
"id": "https://helpkb.markmoffat.com/documentation/articles/",
"content_html": "<h3 id=\"get-single-article\">Get single article</h3>\n<p>Retrieve a single article using the article Url</p>\n<p><strong>URL</strong> : <code>/api/article/:articleurl</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: Single article</p>\n<h4 id=\"success-response\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>An example response:</p>\n<pre><code class=\"language-json\">{\n id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n url: "hello-world",\n title: "Hello world",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n}\n</code></pre>\n<h3 id=\"search-articles\">Search articles</h3>\n<p>Search an article using a keyword</p>\n<p><strong>URL</strong> : <code>/api/search/:searchparam</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: 10 articles</p>\n<h4 id=\"success-response-1\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>An example response:</p>\n<pre><code class=\"language-json\">[\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n url: "hello-world",\n title: "Hello world",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n },\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8c",\n url: "hello-world-two",\n title: "Hello world two",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n }\n]\n</code></pre>\n<h3 id=\"get-recent-articles\">Get recent articles</h3>\n<p>Gets a list of recent articles</p>\n<p><strong>URL</strong> : <code>/api/search/count/:num</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: Number supplied in parameter. Cannot exceeedt the <code>ARTICLE_LIMIT_RETURNED</code> environment variable.</p>\n<h4 id=\"success-response-2\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>An example response:</p>\n<pre><code class=\"language-json\">[\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n url: "hello-world",\n title: "Hello world",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n },\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8c",\n url: "hello-world-two",\n title: "Hello world two",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n }\n]\n</code></pre>\n<h3 id=\"insert-a-new-article\">Insert a new article</h3>\n<p>Inserts a new article</p>\n<p><strong>URL</strong> : <code>/api/article/insert</code></p>\n<p><strong>Method</strong> : <code>PUT</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-3\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example request:</p>\n<pre><code class=\"language-json\">{\n content: "--- content ---"\n}\n</code></pre>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n articleId: "b27e97f5-67e7-4883-9402-c7686da28f8b"\n}\n</code></pre>\n<h3 id=\"update-existing-article\">Update existing article</h3>\n<p>Updates an existing article content</p>\n<p><strong>URL</strong> : <code>/api/article/save</code></p>\n<p><strong>Method</strong> : <code>PUT</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-4\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example request:</p>\n<pre><code class=\"language-json\">{\n content: "--- content ---",\n id: "b27e97f5-67e7-4883-9402-c7686da28f8c"\n}\n</code></pre>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n id: "b27e97f5-67e7-4883-9402-c7686da28f8c",\n url: "hello-world-two",\n title: "Hello world two",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n}\n</code></pre>\n<h3 id=\"deletes-existing-article\">Deletes existing article</h3>\n<p>Deletes an existing article</p>\n<p><strong>URL</strong> : <code>/api/article/delete/:id</code></p>\n<p><strong>Method</strong> : <code>DELETE</code></p>\n<p><strong>Auth required</strong> : YES</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-5\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">{\n <span class=\"hljs-attr\">"success"</span>\n}\n</code></pre>\n<h3 id=\"get-articles-per-category\">Get articles per category</h3>\n<p>Gets the articles in a given category</p>\n<p><strong>URL</strong> : <code>/api/category/:category</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-6\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">[\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n url: "hello-world",\n title: "Hello world",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n },\n {\n id: "b27e97f5-67e7-4883-9402-c7686da28f8c",\n url: "hello-world-two",\n title: "Hello world two",\n content: "--- content ---",\n published: true,\n category: "General",\n pinned: true,\n publishedDate: "2022-06-10T10:50:29.062Z",\n views: 7,\n createdAt: 2022-06-12T06:50:13.724Z,\n updatedAt: 2022-06-16T11:09:09.259Z\n }\n]\n</code></pre>\n<h3 id=\"get-a-list-of-categories\">Get a list of categories</h3>\n<p>Gets an array of available categories</p>\n<p><strong>URL</strong> : <code>/api/categories</code></p>\n<p><strong>Method</strong> : <code>GET</code></p>\n<p><strong>Auth required</strong> : NO</p>\n<p><strong>Limit</strong>: None</p>\n<h4 id=\"success-response-7\">Success Response</h4>\n<p><strong>Code</strong> : <code>200 OK</code></p>\n<p><strong>Content examples</strong></p>\n<p>Example response:</p>\n<pre><code class=\"language-json\">[\n { category: "Configuration", count: "2" },\n { category: "General", count: "1" },\n { category: "Getting started", count: "1" }\n]\n</code></pre>\n",
"url": "https://helpkb.markmoffat.com/documentation/articles/",
"title": "Articles",
"summary": "Documentation - The articles API enables you to manage anything from selecting to deleting and updating articles | helpkb",
"date_modified": "2022-06-16T01:56:00.000Z"
},
{
"id": "https://helpkb.markmoffat.com/features/",
"content_html": "<table class=\"table table-hover table-bordered\">\n<thead>\n<tr>\n<th>Feature</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Sitemap</td>\n<td>Sitemaps are automatically generated. Just submit to Google.</td>\n</tr>\n<tr>\n<td><a href=\"https://en.wikipedia.org/wiki/Markdown\">Markdown</a> syntax</td>\n<td>The powerful and easy to learn <a href=\"https://en.wikipedia.org/wiki/Markdown\">markdown</a> syntax is used for writing posts</td>\n</tr>\n<tr>\n<td>Built with <a href=\"https://nodejs.org/\">Node.js</a> (Javascript)</td>\n<td>Built with <a href=\"https://nodejs.org/\">Node.js</a> meaning anyone with knowledge of Javascript can extend helpkb.</td>\n</tr>\n<tr>\n<td>Multiple environment support</td>\n<td>Create a <a href=\"https://helpkb-docs.markmoffat.com/article/environment-variables/\">config</a> file and setup options for different environments. Eg: Development vs Production</td>\n</tr>\n<tr>\n<td>Easy extended with Nextjs/React knowledge</td>\n<td>Quite often not needed but can easy be written to extend the application</td>\n</tr>\n</tbody>\n</table>\n",
"url": "https://helpkb.markmoffat.com/features/",
"title": "Features",
"summary": "helpkb features - outlining the features supported by the core functionality of helpkb",
"date_modified": "2022-06-16T01:56:00.000Z"
},
{
"id": "https://helpkb.markmoffat.com/documentation/",
"content_html": "<p>See the <code>helpkb</code> API endpoint documentation below:</p>\n<h2>\n <a href=\"/documentation/articles/\">Articles</a>\n</h2>\n<h2>\n <a href=\"/documentation/users/\">Users</a>\n</h2>\n<hr>\n<h1 id=\"demo-%2F-support\">Demo / Support</h1>\n<p>A <code>helpkb</code> instance which has guides and support articles:</p>\n<h2>\n <a href=\"https://helpkb-docs.markmoffat.com\">Support website</a>\n</h2>",
"url": "https://helpkb.markmoffat.com/documentation/",
"title": "Documentation",
"summary": "helpkb documentation - Dive into the offical helpkb API documentation to manage everything from your articles to your users.",
"date_modified": "2022-06-16T01:56:00.000Z"
}
]
}