https://helpkb.markmoffat.com helpkb - Open-source and easy to use knowledge base/faq 2024-01-21T09:18:33.429Z squido A superfast and easy to use knowledge base/faq to help your customers get the info they need, when they need it most. https://helpkb.markmoffat.com/favicon.png <![CDATA[Users]]> https://helpkb.markmoffat.com/documentation/users/ 2022-06-16T01:56:00.000Z Gets a list of users

Retrieves a list of users

URL : /api/users

Method : GET

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

[
    {
        id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
        email: "hi@example.com",
        name: "Jim Smith",
        enabled: true,
        admin: true,
        owner: true,
        createdAt: 2022-06-12T06:50:00.021Z,
        updatedAt: 2022-06-12T06:50:00.021Z
    }
]

Gets a single user

Search an article using a keyword

URL : /api/user/:id

Method : GET

Auth required : YES

Limit: Single user

Success Response

Code : 200 OK

Content examples

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "hi@example.com",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Updates a single user

Updates a given user

URL : /api/user/save

Method : PUT

Auth required : NO

Limit: Single user

Success Response

Code : 200 OK

Content examples

Example request:

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

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "hi@example.com",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Insert a new user

Inserts a new user

URL : /api/user/insert

Method : PUT

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example request:

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

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "hi@example.com",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Deletes existing article

Deletes an existing article content

URL : /api/user/delete/:id

Method : DELETE

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

{
    "success"
}
]]> <![CDATA[Articles]]> https://helpkb.markmoffat.com/documentation/articles/ 2022-06-16T01:56:00.000Z Get single article

Retrieve a single article using the article Url

URL : /api/article/:articleurl

Method : GET

Auth required : NO

Limit: Single article

Success Response

Code : 200 OK

Content examples

An example response:

{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
    url: "hello-world",
    title: "Hello world",
    content: "--- content ---",
    published: true,
    category: "General",
    pinned: true,
    publishedDate: "2022-06-10T10:50:29.062Z",
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}

Search articles

Search an article using a keyword

URL : /api/search/:searchparam

Method : GET

Auth required : NO

Limit: 10 articles

Success Response

Code : 200 OK

Content examples

An example response:

[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]

Get recent articles

Gets a list of recent articles

URL : /api/search/count/:num

Method : GET

Auth required : NO

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

Success Response

Code : 200 OK

Content examples

An example response:

[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]

Insert a new article

Inserts a new article

URL : /api/article/insert

Method : PUT

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example request:

{
    content: "--- content ---"
}

Example response:

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

Update existing article

Updates an existing article content

URL : /api/article/save

Method : PUT

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example request:

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

Example response:

{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
    url: "hello-world-two",
    title: "Hello world two",
    content: "--- content ---",
    published: true,
    category: "General",
    pinned: true,
    publishedDate: "2022-06-10T10:50:29.062Z",
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}

Deletes existing article

Deletes an existing article

URL : /api/article/delete/:id

Method : DELETE

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

{
    "success"
}

Get articles per category

Gets the articles in a given category

URL : /api/category/:category

Method : GET

Auth required : NO

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

[
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
        url: "hello-world",
        title: "Hello world",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: "b27e97f5-67e7-4883-9402-c7686da28f8c",
        url: "hello-world-two",
        title: "Hello world two",
        content: "--- content ---",
        published: true,
        category: "General",
        pinned: true,
        publishedDate: "2022-06-10T10:50:29.062Z",
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]

Get a list of categories

Gets an array of available categories

URL : /api/categories

Method : GET

Auth required : NO

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

[
    { category: "Configuration", count: "2" },
    { category: "General", count: "1" },
    { category: "Getting started", count: "1" }
]
]]> <![CDATA[Features]]> https://helpkb.markmoffat.com/features/ 2022-06-16T01:56:00.000Z Feature Description Sitemap Sitemaps are automatically generated. Just submit to Google. Markdown syntax The 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 support Create a config file and setup options for different environments. Eg: Development vs Production Easy extended with Nextjs/React knowledge Quite often not needed but can easy be written to extend the application ]]> <![CDATA[Documentation]]> https://helpkb.markmoffat.com/documentation/ 2022-06-16T01:56:00.000Z See the helpkb API endpoint documentation below:

Articles

Users

Demo / Support

A helpkb instance which has guides and support articles:

Support website

]]>