Helpjuice API Documentation

This is the complete API documentation for connecting to the Helpjuice API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Helpjuice: Manage Helpjuice knowledge base articles, categories, users, settings, and webhooks. Keep reading to get started.

Quickstart

Before you run your first Helpjuice request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Helpjuice connection — create or choose one in Connections. Note its connectionId.

Every Helpjuice action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/helpjuice/latest/actions/{actionSlug}

You need a MindCloud API Key and a Helpjuice connection. Then call an action such as Get Account Settings:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/helpjuice/latest/actions/get-account-settings" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Helpjuice account that should run the action. MindCloud stores and refreshes the Helpjuice credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Helpjuice actions

All 40 published actions for this Helpjuice version. Each page documents the endpoint, arguments, and response controls.

• PUTActivate User
• POSTCreate Article
• POSTCreate Category
• POSTCreate Group
• POSTCreate User
• POSTCreate Webhook
• PUTDeactivate User
• DELETEDelete Article
• DELETEDelete Group
• DELETEDelete User
• DELETEDelete Webhook
• PUTDownvote Article
• GETGet Account Settings
• GETGet Activity
• GETGet Article
• GETGet Category
• GETGet Group
• GETGet User
• GETGet Webhook
• GETList Activities
• GETList Article Analytics
• GETList Articles
• GETList Backups
• GETList Categories
• GETList Category Analytics
• GETList Group Analytics
• GETList Group Users
• GETList Groups
• GETList Search Analytics
• GETList User Analytics
• GETList Users
• GETList Webhooks
• GETSearch KB
• POSTTest Webhook
• PUTToggle Webhook
• PUTUpdate Article
• PUTUpdate Category
• PUTUpdate Group
• PUTUpdate User
• PUTUpvote Article

Related apps

More Productivity apps on the Universal API, behind the same REST shape. Or browse all apps.

Google CalendarNotionTypeformJira Software CloudSmartsheetCal.comWufooBasecamp