{ "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": "

Gets a list of users

\n

Retrieves a list of users

\n

URL : /api/users

\n

Method : GET

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
[\n    {\n        id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n        email: "hi@example.com",\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
\n

Gets a single user

\n

Search an article using a keyword

\n

URL : /api/user/:id

\n

Method : GET

\n

Auth required : YES

\n

Limit: Single user

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
{\n    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n    email: "hi@example.com",\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

Updates a single user

\n

Updates a given user

\n

URL : /api/user/save

\n

Method : PUT

\n

Auth required : NO

\n

Limit: Single user

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example request:

\n
{\n    id: "b27e97f5-67e7-4883-9402-c7686da28f8b",\n    email: "hi@example.com",\n    name: "Jim Smith",\n    enabled: true,\n    admin: true\n}\n
\n

Example response:

\n
{\n    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n    email: "hi@example.com",\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

Insert a new user

\n

Inserts a new user

\n

URL : /api/user/insert

\n

Method : PUT

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example request:

\n
{\n    email: "hi@example.com",\n    name: "Jim Smith"\n}\n
\n

Example response:

\n
{\n    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",\n    email: "hi@example.com",\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

Deletes existing article

\n

Deletes an existing article content

\n

URL : /api/user/delete/:id

\n

Method : DELETE

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
{\n    "success"\n}\n
\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": "

Get single article

\n

Retrieve a single article using the article Url

\n

URL : /api/article/:articleurl

\n

Method : GET

\n

Auth required : NO

\n

Limit: Single article

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

An example response:

\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

Search articles

\n

Search an article using a keyword

\n

URL : /api/search/:searchparam

\n

Method : GET

\n

Auth required : NO

\n

Limit: 10 articles

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

An example response:

\n
[\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
\n

Get recent articles

\n

Gets a list of recent articles

\n

URL : /api/search/count/:num

\n

Method : GET

\n

Auth required : NO

\n

Limit: Number supplied in parameter. Cannot exceeedt the ARTICLE_LIMIT_RETURNED environment variable.

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

An example response:

\n
[\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
\n

Insert a new article

\n

Inserts a new article

\n

URL : /api/article/insert

\n

Method : PUT

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example request:

\n
{\n    content: "--- content ---"\n}\n
\n

Example response:

\n
{\n    articleId: "b27e97f5-67e7-4883-9402-c7686da28f8b"\n}\n
\n

Update existing article

\n

Updates an existing article content

\n

URL : /api/article/save

\n

Method : PUT

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example request:

\n
{\n    content: "--- content ---",\n    id: "b27e97f5-67e7-4883-9402-c7686da28f8c"\n}\n
\n

Example response:

\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

Deletes existing article

\n

Deletes an existing article

\n

URL : /api/article/delete/:id

\n

Method : DELETE

\n

Auth required : YES

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
{\n    "success"\n}\n
\n

Get articles per category

\n

Gets the articles in a given category

\n

URL : /api/category/:category

\n

Method : GET

\n

Auth required : NO

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
[\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
\n

Get a list of categories

\n

Gets an array of available categories

\n

URL : /api/categories

\n

Method : GET

\n

Auth required : NO

\n

Limit: None

\n

Success Response

\n

Code : 200 OK

\n

Content examples

\n

Example response:

\n
[\n    { category: "Configuration", count: "2" },\n    { category: "General", count: "1" },\n    { category: "Getting started", count: "1" }\n]\n
\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": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FeatureDescription
SitemapSitemaps are automatically generated. Just submit to Google.
Markdown syntaxThe powerful and easy to learn markdown syntax is used for writing posts
Built with Node.js (Javascript)Built with Node.js meaning anyone with knowledge of Javascript can extend helpkb.
Multiple environment supportCreate a config file and setup options for different environments. Eg: Development vs Production
Easy extended with Nextjs/React knowledgeQuite often not needed but can easy be written to extend the application
\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": "

See the helpkb API endpoint documentation below:

\n

\n Articles\n

\n

\n Users\n

\n
\n

Demo / Support

\n

A helpkb instance which has guides and support articles:

\n

\n Support website\n

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