Making API Requests

Updated 7 months ago ​by Jake Peters

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 adequately scoped. For instance, if you're trying to read data you'll need an r key or above. To create or update data you'll need an rw.

r keys are available on the Startup plan and above, rw keys on the Growth plan

To learn more about authentication and API keys, check out these two HelpDocs:


How did we do?