Authenticating API Requests

Updated 1 year ago by Jake Peters

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

For instance, using the popular Node.js request module, you could make a request using Bearer auth like this:

          request.get('', {
            'auth': {
              'bearer': 'your-api-key'

Or you could make the same request with your key as the key query parameter:

All requests to the API must be made via HTTPS to The API is not available through your custom domain or your * subdomain

How did we do?