Managing API Keys
You can create and delete API keys in your account's API settings. Only account owners can manage and view API keys. Every API key has a set of permissions that control what actions the key can perfo…
Authenticating API Requests
The HelpDocs API has a flexible authentication scheme. You can choose to provide your API key as an HTTP Bearer token, or pass it as a query parameter. You must pass your token with every API request…
Making API Requests
All API requests must be made via SSL to the base URL, and data will be returned as JSON. Base URL https://api.helpdocs.io/v1/ You need to authenticate every request with an API key that is adequatel…
The Article Object
Article JSON format, mutable/immutable properties, multilingual support.
Getting Articles
GET /article[?category_id&tag&include_body&updated_at_before] If no arguments are passed it'll return all articles on your account of all article statuses. Arguments Description category_id string (c…
Creating an Article
Create an article with several parameters (including multilingual objects).
Updating an Article
You can update all or part of your article through the API with a PATCH to /article/:article_id. Only send us what's changed.
Deleting an Article
DELETE /article/:article_id Arguments Required? article_id Yes Example response: { "success": true }
Searching For Articles
GET /search[?query&limit] Get the top search results for a given string. Arguments Description query ​​ string Required The search term string you'd like results for limit int How many results you'd…
Error Codes and Responses
The HelpDocs API sends back standard error codes when things go wrong. Code Description 200 OK 400 Missing required parameters for API call 401 Account or user not authorized for this route 404 The d…
The Category Object
Categories returned by the API take this format: { // Dates "created_at": ISODate("2016-06-26T15:30:38.731Z"), "updated_at": ISODate("2016-06-26T15:40:28.926Z"), // Identifiers "account_id": "test_ac…
Creating a Category
POST /category Arguments Required? title Yes description No Example response: { "category": Category }
Getting Categories
GET /category Example response: { "categories": [ Category ] }
Getting a Single Category
GET /category/:category_id Arguments category_id Required ID of the category you're trying to GET Example response: { "category": Category }
Getting a Single Article
GET /article/:article_id If no arguments are passed, returns all articles on your account, of all statuses. Arguments article_id Required Unique ID of the article you're trying to access Example resp…
