Making API Requests

Taylor Sloane Updated by Taylor Sloane

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 a Read key or above. To create or update data you'll need a Write key.

API access and scope varies by plan. You may not be able to create both types of key without an upgrade.

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

How did we do?

Error Codes and Responses

Managing API Keys

Contact

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.